AWS.Tools.OpenSearchServerless.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.OpenSearchServerless</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.OSS.AddOSSResourceTagCmdlet"> <summary> Associates tags with an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.AddOSSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the <code>DELETING</code> state), and must be owned by the account ID included in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.AddOSSResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.AddOSSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.AddOSSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.AddOSSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyCmdlet"> <summary> Returns an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyCmdlet.Name"> <summary> <para> <para>The name of the access policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyCmdlet.Type"> <summary> <para> <para>Tye type of policy. Currently the only supported value is <code>data</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPolicyDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.GetAccessPolicyResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.GetAccessPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet"> <summary> Returns information about a list of OpenSearch Serverless access policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet.Resource"> <summary> <para> <para>Resource filters (can be collections or indexes) that policies can apply to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet.Type"> <summary> <para> <para>The type of access policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet.NextToken"> <summary> <para> <para>If your initial <code>ListAccessPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListAccessPolicies</code> operations, which returns results in the next page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPolicySummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.ListAccessPoliciesResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.ListAccessPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccessPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccountSettingCmdlet"> <summary> Returns account-level settings related to OpenSearch Serverless. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettingsDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.GetAccountSettingsResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.GetAccountSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSCollectionListCmdlet"> <summary> Lists all OpenSearch Serverless collections. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>. <note><para> Make sure to include an empty request body {} if you don't include any collection filters in the request. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSCollectionListCmdlet.CollectionFilters_Name"> <summary> <para> <para>The name of the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSCollectionListCmdlet.CollectionFilters_Status"> <summary> <para> <para>The current status of the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSCollectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSCollectionListCmdlet.NextToken"> <summary> <para> <para>If your initial <code>ListCollections</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListCollections</code> operations, which returns results in the next page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSCollectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CollectionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.ListCollectionsResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.ListCollectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetCollectionCmdlet"> <summary> Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetCollectionCmdlet.Id"> <summary> <para> <para>A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetCollectionCmdlet.Name"> <summary> <para> <para>A list of collection names. You can't provide names and IDs in the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.BatchGetCollectionResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.BatchGetCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetVpcEndpointCmdlet"> <summary> Returns attributes for one or more VPC endpoints associated with the current account. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetVpcEndpointCmdlet.Id"> <summary> <para> <para>A list of VPC endpoint identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSGetVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.BatchGetVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.BatchGetVpcEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSPoliciesStatCmdlet"> <summary> Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSPoliciesStatCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.GetPoliciesStatsResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.GetPoliciesStatsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSResourceTagCmdlet"> <summary> Returns the tags for an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the <code>DELETING</code> state), and must be owned by the account ID included in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigCmdlet"> <summary> Returns information about an OpenSearch Serverless security configuration. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigCmdlet.Id"> <summary> <para> <para>The unique identifier of the security configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityConfigDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.GetSecurityConfigResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.GetSecurityConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigListCmdlet"> <summary> Returns information about configured OpenSearch Serverless security configurations. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigListCmdlet.Type"> <summary> <para> <para>The type of security configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigListCmdlet.NextToken"> <summary> <para> <para>If your initial <code>ListSecurityConfigs</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityConfigs</code> operations, which returns results in the next page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityConfigSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.ListSecurityConfigsResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.ListSecurityConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityConfigListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyCmdlet"> <summary> Returns information about a configured OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at rest for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyCmdlet.Name"> <summary> <para> <para>The name of the security policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyCmdlet.Type"> <summary> <para> <para>The type of security policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityPolicyDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.GetSecurityPolicyResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.GetSecurityPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet"> <summary> Returns information about configured OpenSearch Serverless security policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet.Resource"> <summary> <para> <para>Resource filters (can be collection or indexes) that policies can apply to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet.Type"> <summary> <para> <para>The type of policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet.NextToken"> <summary> <para> <para>If your initial <code>ListSecurityPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityPolicies</code> operations, which returns results in the next page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityPolicySummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.ListSecurityPoliciesResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.ListSecurityPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSSecurityPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.GetOSSVpcEndpointListCmdlet"> <summary> Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSVpcEndpointListCmdlet.VpcEndpointFilters_Status"> <summary> <para> <para>The current status of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSVpcEndpointListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSVpcEndpointListCmdlet.NextToken"> <summary> <para> <para>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSVpcEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcEndpointSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.ListVpcEndpointsResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.ListVpcEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.GetOSSVpcEndpointListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VpcEndpointFilters_Status parameter. The -PassThru parameter is deprecated, use -Select '^VpcEndpointFilters_Status' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet"> <summary> Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.Description"> <summary> <para> <para>A description of the policy. Typically used to store information about the permissions defined in the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.Name"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.Policy"> <summary> <para> <para>The JSON policy document to use as the content for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.Type"> <summary> <para> <para>The type of policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPolicyDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.CreateAccessPolicyResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.CreateAccessPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSAccessPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet"> <summary> Creates a new OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.Description"> <summary> <para> <para>Description of the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.Name"> <summary> <para> <para>Name of the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.Tag"> <summary> <para> <para>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.Type"> <summary> <para> <para>The type of collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CreateCollectionDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.CreateCollectionResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.CreateCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet"> <summary> Specifies a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.Description"> <summary> <para> <para>A description of the security configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.SamlOptions_GroupAttribute"> <summary> <para> <para>The group attribute for this SAML integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.SamlOptions_Metadata"> <summary> <para> <para>The XML IdP metadata file generated from your identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.Name"> <summary> <para> <para>The name of the security configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.SamlOptions_SessionTimeout"> <summary> <para> <para>The session timeout, in minutes. Default is 60 minutes (12 hours).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.Type"> <summary> <para> <para>The type of security configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.SamlOptions_UserAttribute"> <summary> <para> <para>A user attribute for this SAML integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityConfigDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.CreateSecurityConfigResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.CreateSecurityConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet"> <summary> Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at rest for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.Description"> <summary> <para> <para>A description of the policy. Typically used to store information about the permissions defined in the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.Name"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.Policy"> <summary> <para> <para>The JSON policy document to use as the content for the new policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.Type"> <summary> <para> <para>The type of security policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityPolicyDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.CreateSecurityPolicyResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.CreateSecurityPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSSecurityPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet"> <summary> Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.Name"> <summary> <para> <para>The name of the interface endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.SecurityGroupId"> <summary> <para> <para>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.SubnetId"> <summary> <para> <para>The ID of one or more subnets from which you'll access OpenSearch Serverless.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC from which you'll access OpenSearch Serverless.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CreateVpcEndpointDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.CreateVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.CreateVpcEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.NewOSSVpcEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSAccessPolicyCmdlet"> <summary> Deletes an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSAccessPolicyCmdlet.Name"> <summary> <para> <para>The name of the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSAccessPolicyCmdlet.Type"> <summary> <para> <para>The type of policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSAccessPolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSAccessPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.DeleteAccessPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSAccessPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSCollectionCmdlet"> <summary> Deletes an OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSCollectionCmdlet.Id"> <summary> <para> <para>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSCollectionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeleteCollectionDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.DeleteCollectionResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.DeleteCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSResourceTagCmdlet"> <summary> Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the <code>DELETING</code> state), and must be owned by the account ID included in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag or set of tags to remove from the resource. All tag keys in the request must be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityConfigCmdlet"> <summary> Deletes a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityConfigCmdlet.Id"> <summary> <para> <para>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityConfigCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.DeleteSecurityConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityPolicyCmdlet"> <summary> Deletes an OpenSearch Serverless security policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityPolicyCmdlet.Name"> <summary> <para> <para>The name of the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityPolicyCmdlet.Type"> <summary> <para> <para>The type of policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityPolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.DeleteSecurityPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSSecurityPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSVpcEndpointCmdlet"> <summary> Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSVpcEndpointCmdlet.Id"> <summary> <para> <para>The VPC endpoint identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSVpcEndpointCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeleteVpcEndpointDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.DeleteVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.DeleteVpcEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSVpcEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.RemoveOSSVpcEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet"> <summary> Updates an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.Description"> <summary> <para> <para>A description of the policy. Typically used to store information about the permissions defined in the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.Name"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.Policy"> <summary> <para> <para>The JSON policy document to use as the content for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.PolicyVersion"> <summary> <para> <para>The version of the policy being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.Type"> <summary> <para> <para>The type of policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPolicyDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UpdateAccessPolicyResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.UpdateAccessPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccessPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccountSettingCmdlet"> <summary> Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing capacity limits for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccountSettingCmdlet.CapacityLimits_MaxIndexingCapacityInOCU"> <summary> <para> <para>The maximum indexing capacity for collections.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccountSettingCmdlet.CapacityLimits_MaxSearchCapacityInOCU"> <summary> <para> <para>The maximum search capacity for collections.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettingsDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UpdateAccountSettingsResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.UpdateAccountSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSAccountSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet"> <summary> Updates an OpenSearch Serverless collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet.Description"> <summary> <para> <para>A description of the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet.Id"> <summary> <para> <para>The unique identifier of the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpdateCollectionDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UpdateCollectionResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.UpdateCollectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet"> <summary> Updates a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.ConfigVersion"> <summary> <para> <para>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.Description"> <summary> <para> <para>A description of the security configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.SamlOptions_GroupAttribute"> <summary> <para> <para>The group attribute for this SAML integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.Id"> <summary> <para> <para>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.SamlOptions_Metadata"> <summary> <para> <para>The XML IdP metadata file generated from your identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.SamlOptions_SessionTimeout"> <summary> <para> <para>The session timeout, in minutes. Default is 60 minutes (12 hours).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.SamlOptions_UserAttribute"> <summary> <para> <para>A user attribute for this SAML integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityConfigDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UpdateSecurityConfigResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.UpdateSecurityConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet"> <summary> Updates an OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at rest for Amazon OpenSearch Serverless</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.Description"> <summary> <para> <para>A description of the policy. Typically used to store information about the permissions defined in the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.Name"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.Policy"> <summary> <para> <para>The JSON policy document to use as the content for the new policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.PolicyVersion"> <summary> <para> <para>The version of the policy being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.Type"> <summary> <para> <para>The type of access policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityPolicyDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UpdateSecurityPolicyResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.UpdateSecurityPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSSecurityPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet"> <summary> Updates an OpenSearch Serverless-managed interface endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.AddSecurityGroupId"> <summary> <para> <para>The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.AddSubnetId"> <summary> <para> <para>The ID of one or more subnets to add to the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.Id"> <summary> <para> <para>The unique identifier of the interface endpoint to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.RemoveSecurityGroupId"> <summary> <para> <para>The unique identifiers of the security groups to remove from the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.RemoveSubnetId"> <summary> <para> <para>The unique identifiers of the subnets to remove from the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier to ensure idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpdateVpcEndpointDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpenSearchServerless.Model.UpdateVpcEndpointResponse). Specifying the name of a property of type Amazon.OpenSearchServerless.Model.UpdateVpcEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSS.UpdateOSSVpcEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |