OpenSearch Service Serverless 2021-11-01
- Client: Aws\OpenSearchServerless\OpenSearchServerlessClient
- Service ID: opensearchserverless
- Version: 2021-11-01
This page describes the parameters and results for the operations of the OpenSearch Service Serverless (2021-11-01), and shows how to use the Aws\OpenSearchServerless\OpenSearchServerlessClient object to call the described operations. This documentation is specific to the 2021-11-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchGetCollection ( array $params = [] )
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.
- BatchGetVpcEndpoint ( array $params = [] )
Returns attributes for one or more VPC endpoints associated with the current account.
- CreateAccessPolicy ( array $params = [] )
Creates a data access policy for OpenSearch Serverless.
- CreateCollection ( array $params = [] )
Creates a new OpenSearch Serverless collection.
- CreateSecurityConfig ( array $params = [] )
Specifies a security configuration for OpenSearch Serverless.
- CreateSecurityPolicy ( array $params = [] )
Creates a security policy to be used by one or more OpenSearch Serverless collections.
- CreateVpcEndpoint ( array $params = [] )
Creates an OpenSearch Serverless-managed interface VPC endpoint.
- DeleteAccessPolicy ( array $params = [] )
Deletes an OpenSearch Serverless access policy.
- DeleteCollection ( array $params = [] )
Deletes an OpenSearch Serverless collection.
- DeleteSecurityConfig ( array $params = [] )
Deletes a security configuration for OpenSearch Serverless.
- DeleteSecurityPolicy ( array $params = [] )
Deletes an OpenSearch Serverless security policy.
- DeleteVpcEndpoint ( array $params = [] )
Deletes an OpenSearch Serverless-managed interface endpoint.
- GetAccessPolicy ( array $params = [] )
Returns an OpenSearch Serverless access policy.
- GetAccountSettings ( array $params = [] )
Returns account-level settings related to OpenSearch Serverless.
- GetPoliciesStats ( array $params = [] )
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
- GetSecurityConfig ( array $params = [] )
Returns information about an OpenSearch Serverless security configuration.
- GetSecurityPolicy ( array $params = [] )
Returns information about a configured OpenSearch Serverless security policy.
- ListAccessPolicies ( array $params = [] )
Returns information about a list of OpenSearch Serverless access policies.
- ListCollections ( array $params = [] )
Lists all OpenSearch Serverless collections.
- ListSecurityConfigs ( array $params = [] )
Returns information about configured OpenSearch Serverless security configurations.
- ListSecurityPolicies ( array $params = [] )
Returns information about configured OpenSearch Serverless security policies.
- ListTagsForResource ( array $params = [] )
Returns the tags for an OpenSearch Serverless resource.
- ListVpcEndpoints ( array $params = [] )
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
- TagResource ( array $params = [] )
Associates tags with an OpenSearch Serverless resource.
- UntagResource ( array $params = [] )
Removes a tag or set of tags from an OpenSearch Serverless resource.
- UpdateAccessPolicy ( array $params = [] )
Updates an OpenSearch Serverless access policy.
- UpdateAccountSettings ( array $params = [] )
Update the OpenSearch Serverless settings for the current Amazon Web Services account.
- UpdateCollection ( array $params = [] )
Updates an OpenSearch Serverless collection.
- UpdateSecurityConfig ( array $params = [] )
Updates a security configuration for OpenSearch Serverless.
- UpdateSecurityPolicy ( array $params = [] )
Updates an OpenSearch Serverless security policy.
- UpdateVpcEndpoint ( array $params = [] )
Updates an OpenSearch Serverless-managed interface endpoint.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchGetCollection
$result = $client->batchGetCollection([/* ... */]); $promise = $client->batchGetCollectionAsync([/* ... */]);
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Parameter Syntax
$result = $client->batchGetCollection([
'ids' => ['<string>', ...],
'names' => ['<string>', ...],
]);
Parameter Details
Members
- ids
-
- Type: Array of strings
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 ListCollections API.
- names
-
- Type: Array of strings
A list of collection names. You can't provide names and IDs in the same request.
Result Syntax
[
'collectionDetails' => [
[
'arn' => '<string>',
'collectionEndpoint' => '<string>',
'createdDate' => <integer>,
'dashboardEndpoint' => '<string>',
'description' => '<string>',
'id' => '<string>',
'kmsKeyArn' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'status' => 'CREATING|DELETING|ACTIVE|FAILED',
'type' => 'SEARCH|TIMESERIES',
],
// ...
],
'collectionErrorDetails' => [
[
'errorCode' => '<string>',
'errorMessage' => '<string>',
'id' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- collectionDetails
-
- Type: Array of CollectionDetail structures
Details about each collection.
- collectionErrorDetails
-
- Type: Array of CollectionErrorDetail structures
Error information for the request.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
BatchGetVpcEndpoint
$result = $client->batchGetVpcEndpoint([/* ... */]); $promise = $client->batchGetVpcEndpointAsync([/* ... */]);
Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Parameter Syntax
$result = $client->batchGetVpcEndpoint([
'ids' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ids
-
- Required: Yes
- Type: Array of strings
A list of VPC endpoint identifiers.
Result Syntax
[
'vpcEndpointDetails' => [
[
'createdDate' => <integer>,
'id' => '<string>',
'name' => '<string>',
'securityGroupIds' => ['<string>', ...],
'status' => 'PENDING|DELETING|ACTIVE|FAILED',
'subnetIds' => ['<string>', ...],
'vpcId' => '<string>',
],
// ...
],
'vpcEndpointErrorDetails' => [
[
'errorCode' => '<string>',
'errorMessage' => '<string>',
'id' => '<string>',
],
// ...
],
]
Result Details
Members
- vpcEndpointDetails
-
- Type: Array of VpcEndpointDetail structures
Details about the specified VPC endpoint.
- vpcEndpointErrorDetails
-
- Type: Array of VpcEndpointErrorDetail structures
Error information for a failed request.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
CreateAccessPolicy
$result = $client->createAccessPolicy([/* ... */]); $promise = $client->createAccessPolicyAsync([/* ... */]);
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 Data access control for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->createAccessPolicy([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'policy' => '<string>', // REQUIRED
'type' => 'data', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
A description of the policy. Typically used to store information about the permissions defined in the policy.
- name
-
- Required: Yes
- Type: string
The name of the policy.
- policy
-
- Required: Yes
- Type: string
The JSON policy document to use as the content for the policy.
- type
-
- Required: Yes
- Type: string
The type of policy.
Result Syntax
[
'accessPolicyDetail' => [
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policy' => [
],
'policyVersion' => '<string>',
'type' => 'data',
],
]
Result Details
Members
- accessPolicyDetail
-
- Type: AccessPolicyDetail structure
Details about the created access policy.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
CreateCollection
$result = $client->createCollection([/* ... */]); $promise = $client->createCollectionAsync([/* ... */]);
Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Parameter Syntax
$result = $client->createCollection([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'type' => 'SEARCH|TIMESERIES',
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
Description of the collection.
- name
-
- Required: Yes
- Type: string
Name of the collection.
- tags
-
- Type: Array of Tag structures
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
- type
-
- Type: string
The type of collection.
Result Syntax
[
'createCollectionDetail' => [
'arn' => '<string>',
'createdDate' => <integer>,
'description' => '<string>',
'id' => '<string>',
'kmsKeyArn' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'status' => 'CREATING|DELETING|ACTIVE|FAILED',
'type' => 'SEARCH|TIMESERIES',
],
]
Result Details
Members
- createCollectionDetail
-
- Type: CreateCollectionDetail structure
Details about the collection.
Errors
-
OCU Limit Exceeded for service limits
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
CreateSecurityConfig
$result = $client->createSecurityConfig([/* ... */]); $promise = $client->createSecurityConfigAsync([/* ... */]);
Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->createSecurityConfig([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'samlOptions' => [
'groupAttribute' => '<string>',
'metadata' => '<string>', // REQUIRED
'sessionTimeout' => <integer>,
'userAttribute' => '<string>',
],
'type' => 'saml', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
A description of the security configuration.
- name
-
- Required: Yes
- Type: string
The name of the security configuration.
- samlOptions
-
- Type: SamlConfigOptions structure
Describes SAML options in in the form of a key-value map. This field is required if you specify
samlfor thetypeparameter. - type
-
- Required: Yes
- Type: string
The type of security configuration.
Result Syntax
[
'securityConfigDetail' => [
'configVersion' => '<string>',
'createdDate' => <integer>,
'description' => '<string>',
'id' => '<string>',
'lastModifiedDate' => <integer>,
'samlOptions' => [
'groupAttribute' => '<string>',
'metadata' => '<string>',
'sessionTimeout' => <integer>,
'userAttribute' => '<string>',
],
'type' => 'saml',
],
]
Result Details
Members
- securityConfigDetail
-
- Type: SecurityConfigDetail structure
Details about the created security configuration.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
CreateSecurityPolicy
$result = $client->createSecurityPolicy([/* ... */]); $promise = $client->createSecurityPolicyAsync([/* ... */]);
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 Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->createSecurityPolicy([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'policy' => '<string>', // REQUIRED
'type' => 'encryption|network', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
A description of the policy. Typically used to store information about the permissions defined in the policy.
- name
-
- Required: Yes
- Type: string
The name of the policy.
- policy
-
- Required: Yes
- Type: string
The JSON policy document to use as the content for the new policy.
- type
-
- Required: Yes
- Type: string
The type of security policy.
Result Syntax
[
'securityPolicyDetail' => [
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policy' => [
],
'policyVersion' => '<string>',
'type' => 'encryption|network',
],
]
Result Details
Members
- securityPolicyDetail
-
- Type: SecurityPolicyDetail structure
Details about the created security policy.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
CreateVpcEndpoint
$result = $client->createVpcEndpoint([/* ... */]); $promise = $client->createVpcEndpointAsync([/* ... */]);
Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Parameter Syntax
$result = $client->createVpcEndpoint([
'clientToken' => '<string>',
'name' => '<string>', // REQUIRED
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<string>', ...], // REQUIRED
'vpcId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- name
-
- Required: Yes
- Type: string
The name of the interface endpoint.
- securityGroupIds
-
- Type: Array of strings
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
- subnetIds
-
- Required: Yes
- Type: Array of strings
The ID of one or more subnets from which you'll access OpenSearch Serverless.
- vpcId
-
- Required: Yes
- Type: string
The ID of the VPC from which you'll access OpenSearch Serverless.
Result Syntax
[
'createVpcEndpointDetail' => [
'id' => '<string>',
'name' => '<string>',
'status' => 'PENDING|DELETING|ACTIVE|FAILED',
],
]
Result Details
Members
- createVpcEndpointDetail
-
- Type: CreateVpcEndpointDetail structure
Details about the created interface VPC endpoint.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
DeleteAccessPolicy
$result = $client->deleteAccessPolicy([/* ... */]); $promise = $client->deleteAccessPolicyAsync([/* ... */]);
Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->deleteAccessPolicy([
'clientToken' => '<string>',
'name' => '<string>', // REQUIRED
'type' => 'data', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- name
-
- Required: Yes
- Type: string
The name of the policy to delete.
- type
-
- Required: Yes
- Type: string
The type of policy.
Result Syntax
[]
Result Details
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
DeleteCollection
$result = $client->deleteCollection([/* ... */]); $promise = $client->deleteCollectionAsync([/* ... */]);
Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Parameter Syntax
$result = $client->deleteCollection([
'clientToken' => '<string>',
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique, case-sensitive identifier to ensure idempotency of the request.
- id
-
- Required: Yes
- Type: string
The unique identifier of the collection. For example,
1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.
Result Syntax
[
'deleteCollectionDetail' => [
'id' => '<string>',
'name' => '<string>',
'status' => 'CREATING|DELETING|ACTIVE|FAILED',
],
]
Result Details
Members
- deleteCollectionDetail
-
- Type: DeleteCollectionDetail structure
Details of the deleted collection.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
DeleteSecurityConfig
$result = $client->deleteSecurityConfig([/* ... */]); $promise = $client->deleteSecurityConfigAsync([/* ... */]);
Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->deleteSecurityConfig([
'clientToken' => '<string>',
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- id
-
- Required: Yes
- Type: string
The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example,saml/123456789123/OKTADev.
Result Syntax
[]
Result Details
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
DeleteSecurityPolicy
$result = $client->deleteSecurityPolicy([/* ... */]); $promise = $client->deleteSecurityPolicyAsync([/* ... */]);
Deletes an OpenSearch Serverless security policy.
Parameter Syntax
$result = $client->deleteSecurityPolicy([
'clientToken' => '<string>',
'name' => '<string>', // REQUIRED
'type' => 'encryption|network', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- name
-
- Required: Yes
- Type: string
The name of the policy to delete.
- type
-
- Required: Yes
- Type: string
The type of policy.
Result Syntax
[]
Result Details
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
DeleteVpcEndpoint
$result = $client->deleteVpcEndpoint([/* ... */]); $promise = $client->deleteVpcEndpointAsync([/* ... */]);
Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Parameter Syntax
$result = $client->deleteVpcEndpoint([
'clientToken' => '<string>',
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- id
-
- Required: Yes
- Type: string
The VPC endpoint identifier.
Result Syntax
[
'deleteVpcEndpointDetail' => [
'id' => '<string>',
'name' => '<string>',
'status' => 'PENDING|DELETING|ACTIVE|FAILED',
],
]
Result Details
Members
- deleteVpcEndpointDetail
-
- Type: DeleteVpcEndpointDetail structure
Details about the deleted endpoint.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
GetAccessPolicy
$result = $client->getAccessPolicy([/* ... */]); $promise = $client->getAccessPolicyAsync([/* ... */]);
Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->getAccessPolicy([
'name' => '<string>', // REQUIRED
'type' => 'data', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the access policy.
- type
-
- Required: Yes
- Type: string
Tye type of policy. Currently the only supported value is
data.
Result Syntax
[
'accessPolicyDetail' => [
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policy' => [
],
'policyVersion' => '<string>',
'type' => 'data',
],
]
Result Details
Members
- accessPolicyDetail
-
- Type: AccessPolicyDetail structure
Details about the requested access policy.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
Thrown when the HTTP request contains invalid input or is missing required input.
GetAccountSettings
$result = $client->getAccountSettings([/* ... */]); $promise = $client->getAccountSettingsAsync([/* ... */]);
Returns account-level settings related to OpenSearch Serverless.
Parameter Syntax
$result = $client->getAccountSettings([ ]);
Parameter Details
Members
Result Syntax
[
'accountSettingsDetail' => [
'capacityLimits' => [
'maxIndexingCapacityInOCU' => <integer>,
'maxSearchCapacityInOCU' => <integer>,
],
],
]
Result Details
Members
- accountSettingsDetail
-
- Type: AccountSettingsDetail structure
OpenSearch Serverless-related details for the current account.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
GetPoliciesStats
$result = $client->getPoliciesStats([/* ... */]); $promise = $client->getPoliciesStatsAsync([/* ... */]);
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
Parameter Syntax
$result = $client->getPoliciesStats([ ]);
Parameter Details
Members
Result Syntax
[
'AccessPolicyStats' => [
'DataPolicyCount' => <integer>,
],
'SecurityConfigStats' => [
'SamlConfigCount' => <integer>,
],
'SecurityPolicyStats' => [
'EncryptionPolicyCount' => <integer>,
'NetworkPolicyCount' => <integer>,
],
'TotalPolicyCount' => <integer>,
]
Result Details
Members
- AccessPolicyStats
-
- Type: AccessPolicyStats structure
Information about the data access policies in your account.
- SecurityConfigStats
-
- Type: SecurityConfigStats structure
Information about the security configurations in your account.
- SecurityPolicyStats
-
- Type: SecurityPolicyStats structure
Information about the security policies in your account.
- TotalPolicyCount
-
- Type: long (int|float)
The total number of OpenSearch Serverless security policies and configurations in your account.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
GetSecurityConfig
$result = $client->getSecurityConfig([/* ... */]); $promise = $client->getSecurityConfigAsync([/* ... */]);
Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->getSecurityConfig([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
The unique identifier of the security configuration.
Result Syntax
[
'securityConfigDetail' => [
'configVersion' => '<string>',
'createdDate' => <integer>,
'description' => '<string>',
'id' => '<string>',
'lastModifiedDate' => <integer>,
'samlOptions' => [
'groupAttribute' => '<string>',
'metadata' => '<string>',
'sessionTimeout' => <integer>,
'userAttribute' => '<string>',
],
'type' => 'saml',
],
]
Result Details
Members
- securityConfigDetail
-
- Type: SecurityConfigDetail structure
Details of the requested security configuration.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
Thrown when the HTTP request contains invalid input or is missing required input.
GetSecurityPolicy
$result = $client->getSecurityPolicy([/* ... */]); $promise = $client->getSecurityPolicyAsync([/* ... */]);
Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->getSecurityPolicy([
'name' => '<string>', // REQUIRED
'type' => 'encryption|network', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the security policy.
- type
-
- Required: Yes
- Type: string
The type of security policy.
Result Syntax
[
'securityPolicyDetail' => [
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policy' => [
],
'policyVersion' => '<string>',
'type' => 'encryption|network',
],
]
Result Details
Members
- securityPolicyDetail
-
- Type: SecurityPolicyDetail structure
Details about the requested security policy.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
Thrown when the HTTP request contains invalid input or is missing required input.
ListAccessPolicies
$result = $client->listAccessPolicies([/* ... */]); $promise = $client->listAccessPoliciesAsync([/* ... */]);
Returns information about a list of OpenSearch Serverless access policies.
Parameter Syntax
$result = $client->listAccessPolicies([
'maxResults' => <integer>,
'nextToken' => '<string>',
'resource' => ['<string>', ...],
'type' => 'data', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento get the next page of results. The default is 20. - nextToken
-
- Type: string
If your initial
ListAccessPoliciesoperation returns anextToken, you can include the returnednextTokenin subsequentListAccessPoliciesoperations, which returns results in the next page. - resource
-
- Type: Array of strings
Resource filters (can be collections or indexes) that policies can apply to.
- type
-
- Required: Yes
- Type: string
The type of access policy.
Result Syntax
[
'accessPolicySummaries' => [
[
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policyVersion' => '<string>',
'type' => 'data',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- accessPolicySummaries
-
- Type: Array of AccessPolicySummary structures
Details about the requested access policies.
- nextToken
-
- Type: string
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
ListCollections
$result = $client->listCollections([/* ... */]); $promise = $client->listCollectionsAsync([/* ... */]);
Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
Parameter Syntax
$result = $client->listCollections([
'collectionFilters' => [
'name' => '<string>',
'status' => 'CREATING|DELETING|ACTIVE|FAILED',
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- collectionFilters
-
- Type: CollectionFilters structure
List of filter names and values that you can use for requests.
- maxResults
-
- Type: int
The maximum number of results to return. Default is 20. You can use
nextTokento get the next page of results. - nextToken
-
- Type: string
If your initial
ListCollectionsoperation returns anextToken, you can include the returnednextTokenin subsequentListCollectionsoperations, which returns results in the next page.
Result Syntax
[
'collectionSummaries' => [
[
'arn' => '<string>',
'id' => '<string>',
'name' => '<string>',
'status' => 'CREATING|DELETING|ACTIVE|FAILED',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- collectionSummaries
-
- Type: Array of CollectionSummary structures
Details about each collection.
- nextToken
-
- Type: string
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
ListSecurityConfigs
$result = $client->listSecurityConfigs([/* ... */]); $promise = $client->listSecurityConfigsAsync([/* ... */]);
Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->listSecurityConfigs([
'maxResults' => <integer>,
'nextToken' => '<string>',
'type' => 'saml', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento get the next page of results. The default is 20. - nextToken
-
- Type: string
If your initial
ListSecurityConfigsoperation returns anextToken, you can include the returnednextTokenin subsequentListSecurityConfigsoperations, which returns results in the next page. - type
-
- Required: Yes
- Type: string
The type of security configuration.
Result Syntax
[
'nextToken' => '<string>',
'securityConfigSummaries' => [
[
'configVersion' => '<string>',
'createdDate' => <integer>,
'description' => '<string>',
'id' => '<string>',
'lastModifiedDate' => <integer>,
'type' => 'saml',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. - securityConfigSummaries
-
- Type: Array of SecurityConfigSummary structures
Details about the security configurations in your account.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
ListSecurityPolicies
$result = $client->listSecurityPolicies([/* ... */]); $promise = $client->listSecurityPoliciesAsync([/* ... */]);
Returns information about configured OpenSearch Serverless security policies.
Parameter Syntax
$result = $client->listSecurityPolicies([
'maxResults' => <integer>,
'nextToken' => '<string>',
'resource' => ['<string>', ...],
'type' => 'encryption|network', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento get the next page of results. The default is 20. - nextToken
-
- Type: string
If your initial
ListSecurityPoliciesoperation returns anextToken, you can include the returnednextTokenin subsequentListSecurityPoliciesoperations, which returns results in the next page. - resource
-
- Type: Array of strings
Resource filters (can be collection or indexes) that policies can apply to.
- type
-
- Required: Yes
- Type: string
The type of policy.
Result Syntax
[
'nextToken' => '<string>',
'securityPolicySummaries' => [
[
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policyVersion' => '<string>',
'type' => 'encryption|network',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. - securityPolicySummaries
-
- Type: Array of SecurityPolicySummary structures
Details about the security policies in your account.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the
DELETINGstate), and must be owned by the account ID included in the request.
Result Syntax
[
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The tags associated with the resource.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
Thrown when the HTTP request contains invalid input or is missing required input.
ListVpcEndpoints
$result = $client->listVpcEndpoints([/* ... */]); $promise = $client->listVpcEndpointsAsync([/* ... */]);
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Parameter Syntax
$result = $client->listVpcEndpoints([
'maxResults' => <integer>,
'nextToken' => '<string>',
'vpcEndpointFilters' => [
'status' => 'PENDING|DELETING|ACTIVE|FAILED',
],
]);
Parameter Details
Members
- maxResults
-
- Type: int
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento get the next page of results. The default is 20. - nextToken
-
- Type: string
If your initial
ListVpcEndpointsoperation returns anextToken, you can include the returnednextTokenin subsequentListVpcEndpointsoperations, which returns results in the next page. - vpcEndpointFilters
-
- Type: VpcEndpointFilters structure
Filter the results according to the current status of the VPC endpoint. Possible statuses are
CREATING,DELETING,UPDATING,ACTIVE, andFAILED.
Result Syntax
[
'nextToken' => '<string>',
'vpcEndpointSummaries' => [
[
'id' => '<string>',
'name' => '<string>',
'status' => 'PENDING|DELETING|ACTIVE|FAILED',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
When
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. - vpcEndpointSummaries
-
- Type: Array of VpcEndpointSummary structures
Details about each VPC endpoint, including the name and current status.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the
DELETINGstate), and must be owned by the account ID included in the request. - tags
-
- Required: Yes
- Type: Array of Tag structures
A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.
Result Syntax
[]
Result Details
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the
DELETINGstate), and must be owned by the account ID included in the request. - tagKeys
-
- Required: Yes
- Type: Array of strings
The tag or set of tags to remove from the resource. All tag keys in the request must be unique.
Result Syntax
[]
Result Details
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
UpdateAccessPolicy
$result = $client->updateAccessPolicy([/* ... */]); $promise = $client->updateAccessPolicyAsync([/* ... */]);
Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->updateAccessPolicy([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'policy' => '<string>',
'policyVersion' => '<string>', // REQUIRED
'type' => 'data', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
A description of the policy. Typically used to store information about the permissions defined in the policy.
- name
-
- Required: Yes
- Type: string
The name of the policy.
- policy
-
- Type: string
The JSON policy document to use as the content for the policy.
- policyVersion
-
- Required: Yes
- Type: string
The version of the policy being updated.
- type
-
- Required: Yes
- Type: string
The type of policy.
Result Syntax
[
'accessPolicyDetail' => [
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policy' => [
],
'policyVersion' => '<string>',
'type' => 'data',
],
]
Result Details
Members
- accessPolicyDetail
-
- Type: AccessPolicyDetail structure
Details about the updated access policy.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
UpdateAccountSettings
$result = $client->updateAccountSettings([/* ... */]); $promise = $client->updateAccountSettingsAsync([/* ... */]);
Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->updateAccountSettings([
'capacityLimits' => [
'maxIndexingCapacityInOCU' => <integer>,
'maxSearchCapacityInOCU' => <integer>,
],
]);
Parameter Details
Members
- capacityLimits
-
- Type: CapacityLimits structure
The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
Result Syntax
[
'accountSettingsDetail' => [
'capacityLimits' => [
'maxIndexingCapacityInOCU' => <integer>,
'maxSearchCapacityInOCU' => <integer>,
],
],
]
Result Details
Members
- accountSettingsDetail
-
- Type: AccountSettingsDetail structure
OpenSearch Serverless-related settings for the current Amazon Web Services account.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when the HTTP request contains invalid input or is missing required input.
UpdateCollection
$result = $client->updateCollection([/* ... */]); $promise = $client->updateCollectionAsync([/* ... */]);
Updates an OpenSearch Serverless collection.
Parameter Syntax
$result = $client->updateCollection([
'clientToken' => '<string>',
'description' => '<string>',
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
A description of the collection.
- id
-
- Required: Yes
- Type: string
The unique identifier of the collection.
Result Syntax
[
'updateCollectionDetail' => [
'arn' => '<string>',
'createdDate' => <integer>,
'description' => '<string>',
'id' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'status' => 'CREATING|DELETING|ACTIVE|FAILED',
'type' => 'SEARCH|TIMESERIES',
],
]
Result Details
Members
- updateCollectionDetail
-
- Type: UpdateCollectionDetail structure
Details about the updated collection.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
UpdateSecurityConfig
$result = $client->updateSecurityConfig([/* ... */]); $promise = $client->updateSecurityConfigAsync([/* ... */]);
Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->updateSecurityConfig([
'clientToken' => '<string>',
'configVersion' => '<string>', // REQUIRED
'description' => '<string>',
'id' => '<string>', // REQUIRED
'samlOptions' => [
'groupAttribute' => '<string>',
'metadata' => '<string>', // REQUIRED
'sessionTimeout' => <integer>,
'userAttribute' => '<string>',
],
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- configVersion
-
- Required: Yes
- Type: string
The version of the security configuration to be updated. You can find the most recent version of a security configuration using the
GetSecurityPolicycommand. - description
-
- Type: string
A description of the security configuration.
- id
-
- Required: Yes
- Type: string
The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example,saml/123456789123/OKTADev. - samlOptions
-
- Type: SamlConfigOptions structure
SAML options in in the form of a key-value map.
Result Syntax
[
'securityConfigDetail' => [
'configVersion' => '<string>',
'createdDate' => <integer>,
'description' => '<string>',
'id' => '<string>',
'lastModifiedDate' => <integer>,
'samlOptions' => [
'groupAttribute' => '<string>',
'metadata' => '<string>',
'sessionTimeout' => <integer>,
'userAttribute' => '<string>',
],
'type' => 'saml',
],
]
Result Details
Members
- securityConfigDetail
-
- Type: SecurityConfigDetail structure
Details about the updated security configuration.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
UpdateSecurityPolicy
$result = $client->updateSecurityPolicy([/* ... */]); $promise = $client->updateSecurityPolicyAsync([/* ... */]);
Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
Parameter Syntax
$result = $client->updateSecurityPolicy([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'policy' => '<string>',
'policyVersion' => '<string>', // REQUIRED
'type' => 'encryption|network', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- description
-
- Type: string
A description of the policy. Typically used to store information about the permissions defined in the policy.
- name
-
- Required: Yes
- Type: string
The name of the policy.
- policy
-
- Type: string
The JSON policy document to use as the content for the new policy.
- policyVersion
-
- Required: Yes
- Type: string
The version of the policy being updated.
- type
-
- Required: Yes
- Type: string
The type of access policy.
Result Syntax
[
'securityPolicyDetail' => [
'createdDate' => <integer>,
'description' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'policy' => [
],
'policyVersion' => '<string>',
'type' => 'encryption|network',
],
]
Result Details
Members
- securityPolicyDetail
-
- Type: SecurityPolicyDetail structure
Details about the updated security policy.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
Thrown when accessing or deleting a resource that does not exist.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
-
ServiceQuotaExceededException:
Thrown when you attempt to create more resources than the service allows based on service quotas.
UpdateVpcEndpoint
$result = $client->updateVpcEndpoint([/* ... */]); $promise = $client->updateVpcEndpointAsync([/* ... */]);
Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Parameter Syntax
$result = $client->updateVpcEndpoint([
'addSecurityGroupIds' => ['<string>', ...],
'addSubnetIds' => ['<string>', ...],
'clientToken' => '<string>',
'id' => '<string>', // REQUIRED
'removeSecurityGroupIds' => ['<string>', ...],
'removeSubnetIds' => ['<string>', ...],
]);
Parameter Details
Members
- addSecurityGroupIds
-
- Type: Array of strings
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.
- addSubnetIds
-
- Type: Array of strings
The ID of one or more subnets to add to the endpoint.
- clientToken
-
- Type: string
Unique, case-sensitive identifier to ensure idempotency of the request.
- id
-
- Required: Yes
- Type: string
The unique identifier of the interface endpoint to update.
- removeSecurityGroupIds
-
- Type: Array of strings
The unique identifiers of the security groups to remove from the endpoint.
- removeSubnetIds
-
- Type: Array of strings
The unique identifiers of the subnets to remove from the endpoint.
Result Syntax
[
'UpdateVpcEndpointDetail' => [
'id' => '<string>',
'lastModifiedDate' => <integer>,
'name' => '<string>',
'securityGroupIds' => ['<string>', ...],
'status' => 'PENDING|DELETING|ACTIVE|FAILED',
'subnetIds' => ['<string>', ...],
],
]
Result Details
Members
- UpdateVpcEndpointDetail
-
- Type: UpdateVpcEndpointDetail structure
Details about the updated VPC endpoint.
Errors
-
Thrown when an error internal to the service occurs while processing a request.
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
-
Thrown when the HTTP request contains invalid input or is missing required input.
Shapes
AccessPolicyDetail
Description
Details about an OpenSearch Serverless access policy.
Members
- createdDate
-
- Type: long (int|float)
The date the policy was created.
- description
-
- Type: string
The description of the policy.
- lastModifiedDate
-
- Type: long (int|float)
The timestamp of when the policy was last modified.
- name
-
- Type: string
The name of the policy.
- policy
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The JSON policy document without any whitespaces.
- policyVersion
-
- Type: string
The version of the policy.
- type
-
- Type: string
The type of access policy.
AccessPolicyStats
Description
Statistics for an OpenSearch Serverless access policy.
Members
- DataPolicyCount
-
- Type: long (int|float)
The number of data access policies in the current account.
AccessPolicySummary
Description
A summary of the data access policy.
Members
- createdDate
-
- Type: long (int|float)
The Epoch time when the access policy was created.
- description
-
- Type: string
The description of the access policy.
- lastModifiedDate
-
- Type: long (int|float)
The date and time when the collection was last modified.
- name
-
- Type: string
The name of the access policy.
- policyVersion
-
- Type: string
The version of the policy.
- type
-
- Type: string
The type of access policy. Currently the only available type is
data.
AccountSettingsDetail
Description
OpenSearch Serverless-related information for the current account.
Members
- capacityLimits
-
- Type: CapacityLimits structure
The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
CapacityLimits
Description
The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
Members
- maxIndexingCapacityInOCU
-
- Type: int
The maximum indexing capacity for collections.
- maxSearchCapacityInOCU
-
- Type: int
The maximum search capacity for collections.
CollectionDetail
Description
Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the collection.
- collectionEndpoint
-
- Type: string
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- createdDate
-
- Type: long (int|float)
The Epoch time when the collection was created.
- dashboardEndpoint
-
- Type: string
Collection-specific endpoint used to access OpenSearch Dashboards.
- description
-
- Type: string
A description of the collection.
- id
-
- Type: string
A unique identifier for the collection.
- kmsKeyArn
-
- Type: string
The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- lastModifiedDate
-
- Type: long (int|float)
The date and time when the collection was last modified.
- name
-
- Type: string
The name of the collection.
- status
-
- Type: string
The current status of the collection.
- type
-
- Type: string
The type of collection.
CollectionErrorDetail
Description
Error information for an OpenSearch Serverless request.
Members
- errorCode
-
- Type: string
The error code for the request. For example,
NOT_FOUND. - errorMessage
-
- Type: string
A description of the error. For example,
The specified Collection is not found. - id
-
- Type: string
If the request contains collection IDs, the response includes the IDs provided in the request.
- name
-
- Type: string
If the request contains collection names, the response includes the names provided in the request.
CollectionFilters
Description
List of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.
Members
- name
-
- Type: string
The name of the collection.
- status
-
- Type: string
The current status of the collection.
CollectionSummary
Description
Details about each OpenSearch Serverless collection.
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the collection.
- id
-
- Type: string
The unique identifier of the collection.
- name
-
- Type: string
The name of the collection.
- status
-
- Type: string
The current status of the collection.
ConflictException
Description
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
Members
- message
-
- Type: string
CreateCollectionDetail
Description
Details about the created OpenSearch Serverless collection.
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the collection.
- createdDate
-
- Type: long (int|float)
The Epoch time when the collection was created.
- description
-
- Type: string
A description of the collection.
- id
-
- Type: string
The unique identifier of the collection.
- kmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
- lastModifiedDate
-
- Type: long (int|float)
The date and time when the collection was last modified.
- name
-
- Type: string
The name of the collection.
- status
-
- Type: string
The current status of the collection.
- type
-
- Type: string
The type of collection.
CreateVpcEndpointDetail
Description
Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Members
- id
-
- Type: string
The unique identifier of the endpoint.
- name
-
- Type: string
The name of the endpoint.
- status
-
- Type: string
The current status in the endpoint creation process.
DeleteCollectionDetail
Description
Details about a deleted OpenSearch Serverless collection.
Members
- id
-
- Type: string
The unique identifier of the collection.
- name
-
- Type: string
The name of the collection.
- status
-
- Type: string
The current status of the collection.
DeleteVpcEndpointDetail
Description
Deletion details for an OpenSearch Serverless-managed interface endpoint.
Members
- id
-
- Type: string
The unique identifier of the endpoint.
- name
-
- Type: string
The name of the endpoint.
- status
-
- Type: string
The current status of the endpoint deletion process.
Document
Members
InternalServerException
Description
Thrown when an error internal to the service occurs while processing a request.
Members
- message
-
- Type: string
OcuLimitExceededException
Description
OCU Limit Exceeded for service limits
Members
- message
-
- Required: Yes
- Type: string
Description of the error.
ResourceNotFoundException
Description
Thrown when accessing or deleting a resource that does not exist.
Members
- message
-
- Type: string
SamlConfigOptions
Description
Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
Members
- groupAttribute
-
- Type: string
The group attribute for this SAML integration.
- metadata
-
- Required: Yes
- Type: string
The XML IdP metadata file generated from your identity provider.
- sessionTimeout
-
- Type: int
The session timeout, in minutes. Default is 60 minutes (12 hours).
- userAttribute
-
- Type: string
A user attribute for this SAML integration.
SecurityConfigDetail
Description
Details about a security configuration for OpenSearch Serverless.
Members
- configVersion
-
- Type: string
The version of the security configuration.
- createdDate
-
- Type: long (int|float)
The date the configuration was created.
- description
-
- Type: string
The description of the security configuration.
- id
-
- Type: string
The unique identifier of the security configuration.
- lastModifiedDate
-
- Type: long (int|float)
The timestamp of when the configuration was last modified.
- samlOptions
-
- Type: SamlConfigOptions structure
SAML options for the security configuration in the form of a key-value map.
- type
-
- Type: string
The type of security configuration.
SecurityConfigStats
Description
Statistics for an OpenSearch Serverless security configuration.
Members
- SamlConfigCount
-
- Type: long (int|float)
The number of security configurations in the current account.
SecurityConfigSummary
Description
A summary of a security configuration for OpenSearch Serverless.
Members
- configVersion
-
- Type: string
The version of the security configuration.
- createdDate
-
- Type: long (int|float)
The Epoch time when the security configuration was created.
- description
-
- Type: string
The description of the security configuration.
- id
-
- Type: string
The unique identifier of the security configuration.
- lastModifiedDate
-
- Type: long (int|float)
The timestamp of when the configuration was last modified.
- type
-
- Type: string
The type of security configuration.
SecurityPolicyDetail
Description
Details about an OpenSearch Serverless security policy.
Members
- createdDate
-
- Type: long (int|float)
The date the policy was created.
- description
-
- Type: string
The description of the security policy.
- lastModifiedDate
-
- Type: long (int|float)
The timestamp of when the policy was last modified.
- name
-
- Type: string
The name of the policy.
- policy
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The JSON policy document without any whitespaces.
- policyVersion
-
- Type: string
The version of the policy.
- type
-
- Type: string
The type of security policy.
SecurityPolicyStats
Description
Statistics for an OpenSearch Serverless security policy.
Members
- EncryptionPolicyCount
-
- Type: long (int|float)
The number of encryption policies in the current account.
- NetworkPolicyCount
-
- Type: long (int|float)
The number of network policies in the current account.
SecurityPolicySummary
Description
A summary of a security policy for OpenSearch Serverless.
Members
- createdDate
-
- Type: long (int|float)
The date the policy was created.
- description
-
- Type: string
The description of the security policy.
- lastModifiedDate
-
- Type: long (int|float)
The timestamp of when the policy was last modified.
- name
-
- Type: string
The name of the policy.
- policyVersion
-
- Type: string
The version of the policy.
- type
-
- Type: string
The type of security policy.
ServiceQuotaExceededException
Description
Thrown when you attempt to create more resources than the service allows based on service quotas.
Members
- message
-
- Required: Yes
- Type: string
Description of the error.
- quotaCode
-
- Type: string
Service Quotas requirement to identify originating quota.
- resourceId
-
- Type: string
Identifier of the resource affected.
- resourceType
-
- Type: string
Type of the resource affected.
- serviceCode
-
- Required: Yes
- Type: string
Service Quotas requirement to identify originating service.
Tag
Description
A map of key-value pairs associated to an OpenSearch Serverless resource.
Members
- key
-
- Required: Yes
- Type: string
The key to use in the tag.
- value
-
- Required: Yes
- Type: string
The value of the tag.
UpdateCollectionDetail
Description
Details about an updated OpenSearch Serverless collection.
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the collection.
- createdDate
-
- Type: long (int|float)
The date and time when the collection was created.
- description
-
- Type: string
The description of the collection.
- id
-
- Type: string
The unique identifier of the collection.
- lastModifiedDate
-
- Type: long (int|float)
The date and time when the collection was last modified.
- name
-
- Type: string
The name of the collection.
- status
-
- Type: string
The current status of the collection.
- type
-
- Type: string
The collection type.
UpdateVpcEndpointDetail
Description
Update details for an OpenSearch Serverless-managed interface endpoint.
Members
- id
-
- Type: string
The unique identifier of the endpoint.
- lastModifiedDate
-
- Type: long (int|float)
The timestamp of when the endpoint was last modified.
- name
-
- Type: string
The name of the endpoint.
- securityGroupIds
-
- Type: Array of strings
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
- status
-
- Type: string
The current status of the endpoint update process.
- subnetIds
-
- Type: Array of strings
The ID of the subnets from which you access OpenSearch Serverless.
ValidationException
Description
Thrown when the HTTP request contains invalid input or is missing required input.
Members
- message
-
- Type: string
VpcEndpointDetail
Description
Details about an OpenSearch Serverless-managed interface endpoint.
Members
- createdDate
-
- Type: long (int|float)
The date the endpoint was created.
- id
-
- Type: string
The unique identifier of the endpoint.
- name
-
- Type: string
The name of the endpoint.
- securityGroupIds
-
- Type: Array of strings
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
- status
-
- Type: string
The current status of the endpoint.
- subnetIds
-
- Type: Array of strings
The ID of the subnets from which you access OpenSearch Serverless.
- vpcId
-
- Type: string
The ID of the VPC from which you access OpenSearch Serverless.
VpcEndpointErrorDetail
Description
Error information for a failed BatchGetVpcEndpoint request.
Members
- errorCode
-
- Type: string
The error code for the failed request.
- errorMessage
-
- Type: string
An error message describing the reason for the failure.
- id
-
- Type: string
The unique identifier of the VPC endpoint.
VpcEndpointFilters
Description
Filter the results of a ListVpcEndpoints request.
Members
- status
-
- Type: string
The current status of the endpoint.
VpcEndpointSummary
Description
The VPC endpoint object.
Members
- id
-
- Type: string
The unique identifier of the endpoint.
- name
-
- Type: string
The name of the endpoint.
- status
-
- Type: string
The current status of the endpoint.