AWS SDK for PHP 3.x (original) (raw)

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.

BatchGetEffectiveLifecyclePolicy

result=result = result=client->batchGetEffectiveLifecyclePolicy([/* ... /]); promise=promise = promise=client->batchGetEffectiveLifecyclePolicyAsync([/ ... */]);

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

Parameter Syntax

result=result = result=client->batchGetEffectiveLifecyclePolicy([ 'resourceIdentifiers' => [ // REQUIRED [ 'resource' => '', // REQUIRED 'type' => 'retention', // REQUIRED ], // ... ], ]);

Parameter Details

Members

resourceIdentifiers

Required: Yes

Type: Array of LifecyclePolicyResourceIdentifier structures

The unique identifiers of policy types and resource names.

Result Syntax

[ 'effectiveLifecyclePolicyDetails' => [ [ 'noMinRetentionPeriod' => true || false, 'policyName' => '', 'resource' => '', 'resourceType' => 'index', 'retentionPeriod' => '', 'type' => 'retention', ], // ... ], 'effectiveLifecyclePolicyErrorDetails' => [ [ 'errorCode' => '', 'errorMessage' => '', 'resource' => '', 'type' => 'retention', ], // ... ], ]

Result Details

Members

effectiveLifecyclePolicyDetails

Type: Array of EffectiveLifecyclePolicyDetail structures

A list of lifecycle policies applied to the OpenSearch Serverless indexes.

effectiveLifecyclePolicyErrorDetails

Type: Array of EffectiveLifecyclePolicyErrorDetail structures

A list of resources for which retrieval failed.

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.

BatchGetLifecyclePolicy

result=result = result=client->batchGetLifecyclePolicy([/* ... /]); promise=promise = promise=client->batchGetLifecyclePolicyAsync([/ ... */]);

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Parameter Syntax

result=result = result=client->batchGetLifecyclePolicy([ 'identifiers' => [ // REQUIRED [ 'name' => '', // REQUIRED 'type' => 'retention', // REQUIRED ], // ... ], ]);

Parameter Details

Members

identifiers

Required: Yes

Type: Array of LifecyclePolicyIdentifier structures

The unique identifiers of policy types and policy names.

Result Syntax

[ 'lifecyclePolicyDetails' => [ [ 'createdDate' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', 'type' => 'retention', ], // ... ], 'lifecyclePolicyErrorDetails' => [ [ 'errorCode' => '', 'errorMessage' => '', 'name' => '', 'type' => 'retention', ], // ... ], ]

Result Details

Members

lifecyclePolicyDetails

Type: Array of LifecyclePolicyDetail structures

A list of lifecycle policies matched to the input policy name and policy type.

lifecyclePolicyErrorDetails

Type: Array of LifecyclePolicyErrorDetail structures

A list of lifecycle policy names and policy types for which retrieval failed.

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=result = result=client->batchGetVpcEndpoint([/* ... /]); promise=promise = 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=result = result=client->batchGetVpcEndpoint([ 'ids' => ['', ...], // REQUIRED ]);

Parameter Details

Members

ids

Required: Yes

Type: Array of strings

A list of VPC endpoint identifiers.

Result Syntax

[ 'vpcEndpointDetails' => [ [ 'createdDate' => , 'failureCode' => '', 'failureMessage' => '', 'id' => '', 'name' => '', 'securityGroupIds' => ['', ...], 'status' => 'PENDING|DELETING|ACTIVE|FAILED', 'subnetIds' => ['', ...], 'vpcId' => '', ], // ... ], 'vpcEndpointErrorDetails' => [ [ 'errorCode' => '', 'errorMessage' => '', 'id' => '', ], // ... ], ]

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=result = result=client->createAccessPolicy([/* ... /]); promise=promise = 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=result = result=client->createAccessPolicy([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'policy' => '', // REQUIRED 'type' => 'data', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', '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.

OcuLimitExceededException:

Thrown when you attempt to create more resources than the service allows based on service quotas.

CreateCollection

result=result = result=client->createCollection([/* ... /]); promise=promise = promise=client->createCollectionAsync([/ ... */]);

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Parameter Syntax

result=result = result=client->createCollection([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'standbyReplicas' => 'ENABLED|DISABLED', 'tags' => [ [ 'key' => '', // REQUIRED 'value' => '', // REQUIRED ], // ... ], 'type' => 'SEARCH|TIMESERIES|VECTORSEARCH', ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

Description of the collection.

name

Required: Yes

Type: string

Name of the collection.

standbyReplicas

Indicates whether standby replicas should be used for a collection.

tags

Type: Array of Tag structures

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

type

The type of collection.

Result Syntax

Result Details

Members

createCollectionDetail

Type: CreateCollectionDetail structure

Details about the collection.

Errors

Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.

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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

CreateLifecyclePolicy

result=result = result=client->createLifecyclePolicy([/* ... /]); promise=promise = promise=client->createLifecyclePolicyAsync([/ ... */]);

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.

Parameter Syntax

result=result = result=client->createLifecyclePolicy([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'policy' => '', // REQUIRED 'type' => 'retention', // REQUIRED ]);

Parameter Details

Members

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request.

description

A description of the lifecycle policy.

name

Required: Yes

Type: string

The name of the lifecycle policy.

policy

Required: Yes

Type: string

The JSON policy document to use as the content for the lifecycle policy.

type

Required: Yes

Type: string

The type of lifecycle policy.

Result Syntax

[ 'lifecyclePolicyDetail' => [ 'createdDate' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', 'type' => 'retention', ], ]

Result Details

Members

lifecyclePolicyDetail

Type: LifecyclePolicyDetail structure

Details about the created lifecycle 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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

CreateSecurityConfig

result=result = result=client->createSecurityConfig([/* ... /]); promise=promise = promise=client->createSecurityConfigAsync([/ ... */]);

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->createSecurityConfig([ 'clientToken' => '', 'description' => '', 'iamIdentityCenterOptions' => [ 'groupAttribute' => 'GroupId|GroupName', 'instanceArn' => '', // REQUIRED 'userAttribute' => 'UserId|UserName|Email', ], 'name' => '', // REQUIRED 'samlOptions' => [ 'groupAttribute' => '', 'metadata' => '', // REQUIRED 'openSearchServerlessEntityId' => '', 'sessionTimeout' => , 'userAttribute' => '', ], 'type' => 'saml|iamidentitycenter', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

A description of the security configuration.

iamIdentityCenterOptions

Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

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 saml for the type parameter.

type

Required: Yes

Type: string

The type of security configuration.

Result Syntax

[ 'securityConfigDetail' => [ 'configVersion' => '', 'createdDate' => , 'description' => '', 'iamIdentityCenterOptions' => [ 'applicationArn' => '', 'applicationDescription' => '', 'applicationName' => '', 'groupAttribute' => 'GroupId|GroupName', 'instanceArn' => '', 'userAttribute' => 'UserId|UserName|Email', ], 'id' => '', 'lastModifiedDate' => , 'samlOptions' => [ 'groupAttribute' => '', 'metadata' => '', 'openSearchServerlessEntityId' => '', 'sessionTimeout' => , 'userAttribute' => '', ], 'type' => 'saml|iamidentitycenter', ], ]

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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

CreateSecurityPolicy

result=result = result=client->createSecurityPolicy([/* ... /]); promise=promise = 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=result = result=client->createSecurityPolicy([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'policy' => '', // REQUIRED 'type' => 'encryption|network', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', '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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

CreateVpcEndpoint

result=result = result=client->createVpcEndpoint([/* ... /]); promise=promise = 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=result = result=client->createVpcEndpoint([ 'clientToken' => '', 'name' => '', // REQUIRED 'securityGroupIds' => ['', ...], 'subnetIds' => ['', ...], // REQUIRED 'vpcId' => '', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

name

Required: Yes

Type: string

The name of the interface endpoint.

securityGroupIds

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' => '', 'name' => '', '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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

DeleteAccessPolicy

result=result = result=client->deleteAccessPolicy([/* ... /]); promise=promise = promise=client->deleteAccessPolicyAsync([/ ... */]);

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->deleteAccessPolicy([ 'clientToken' => '', 'name' => '', // REQUIRED 'type' => 'data', // REQUIRED ]);

Parameter Details

Members

clientToken

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

The results for this operation are always empty.

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=result = result=client->deleteCollection([/* ... /]); promise=promise = promise=client->deleteCollectionAsync([/ ... */]);

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Parameter Syntax

result=result = result=client->deleteCollection([ 'clientToken' => '', 'id' => '', // REQUIRED ]);

Parameter Details

Members

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request.

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' => '', 'name' => '', '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.

DeleteLifecyclePolicy

result=result = result=client->deleteLifecyclePolicy([/* ... /]); promise=promise = promise=client->deleteLifecyclePolicyAsync([/ ... */]);

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

Parameter Syntax

result=result = result=client->deleteLifecyclePolicy([ 'clientToken' => '', 'name' => '', // REQUIRED 'type' => 'retention', // REQUIRED ]);

Parameter Details

Members

clientToken

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 lifecycle policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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=result = result=client->deleteSecurityConfig([/* ... /]); promise=promise = promise=client->deleteSecurityConfigAsync([/ ... */]);

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->deleteSecurityConfig([ 'clientToken' => '', 'id' => '', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

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

The results for this operation are always empty.

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=result = result=client->deleteSecurityPolicy([/* ... /]); promise=promise = promise=client->deleteSecurityPolicyAsync([/ ... */]);

Deletes an OpenSearch Serverless security policy.

Parameter Syntax

result=result = result=client->deleteSecurityPolicy([ 'clientToken' => '', 'name' => '', // REQUIRED 'type' => 'encryption|network', // REQUIRED ]);

Parameter Details

Members

clientToken

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

The results for this operation are always empty.

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=result = result=client->deleteVpcEndpoint([/* ... /]); promise=promise = 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=result = result=client->deleteVpcEndpoint([ 'clientToken' => '', 'id' => '', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

Required: Yes

Type: string

The VPC endpoint identifier.

Result Syntax

[ 'deleteVpcEndpointDetail' => [ 'id' => '', 'name' => '', '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=result = result=client->getAccessPolicy([/* ... /]); promise=promise = promise=client->getAccessPolicyAsync([/ ... */]);

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->getAccessPolicy([ 'name' => '', // 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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', '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=result = result=client->getAccountSettings([/* ... /]); promise=promise = promise=client->getAccountSettingsAsync([/ ... */]);

Returns account-level settings related to OpenSearch Serverless.

Parameter Syntax

result=result = result=client->getAccountSettings([ ]);

Parameter Details

Members

Result Syntax

[ 'accountSettingsDetail' => [ 'capacityLimits' => [ 'maxIndexingCapacityInOCU' => , 'maxSearchCapacityInOCU' => , ], ], ]

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=result = result=client->getPoliciesStats([/* ... /]); promise=promise = promise=client->getPoliciesStatsAsync([/ ... */]);

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

Parameter Syntax

result=result = result=client->getPoliciesStats([ ]);

Parameter Details

Members

Result Syntax

[ 'AccessPolicyStats' => [ 'DataPolicyCount' => , ], 'LifecyclePolicyStats' => [ 'RetentionPolicyCount' => , ], 'SecurityConfigStats' => [ 'SamlConfigCount' => , ], 'SecurityPolicyStats' => [ 'EncryptionPolicyCount' => , 'NetworkPolicyCount' => , ], 'TotalPolicyCount' => , ]

Result Details

Members

AccessPolicyStats

Type: AccessPolicyStats structure

Information about the data access policies in your account.

LifecyclePolicyStats

Type: LifecyclePolicyStats structure

Information about the lifecycle 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

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=result = result=client->getSecurityConfig([/* ... /]); promise=promise = promise=client->getSecurityConfigAsync([/ ... */]);

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->getSecurityConfig([ 'id' => '', // REQUIRED ]);

Parameter Details

Members

Required: Yes

Type: string

The unique identifier of the security configuration.

Result Syntax

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=result = result=client->getSecurityPolicy([/* ... /]); promise=promise = 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=result = result=client->getSecurityPolicy([ 'name' => '', // 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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', '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=result = result=client->listAccessPolicies([/* ... /]); promise=promise = promise=client->listAccessPoliciesAsync([/ ... */]);

Returns information about a list of OpenSearch Serverless access policies.

Parameter Syntax

result=result = result=client->listAccessPolicies([ 'maxResults' => , 'nextToken' => '', 'resource' => ['', ...], 'type' => 'data', // REQUIRED ]);

Parameter Details

Members

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

nextToken

If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.

resource

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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policyVersion' => '', 'type' => 'data', ], // ... ], 'nextToken' => '', ]

Result Details

Members

accessPolicySummaries

Type: Array of AccessPolicySummary structures

Details about the requested access policies.

nextToken

When nextToken is returned, there are more results available. The value of nextToken is 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=result = result=client->listCollections([/* ... /]); promise=promise = 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=result = result=client->listCollections([ 'collectionFilters' => [ 'name' => '', 'status' => 'CREATING|DELETING|ACTIVE|FAILED', ], 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

collectionFilters

Type: CollectionFilters structure

A list of filter names and values that you can use for requests.

maxResults

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

nextToken

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Result Syntax

[ 'collectionSummaries' => [ [ 'arn' => '', 'id' => '', 'name' => '', 'status' => 'CREATING|DELETING|ACTIVE|FAILED', ], // ... ], 'nextToken' => '', ]

Result Details

Members

collectionSummaries

Type: Array of CollectionSummary structures

Details about each collection.

nextToken

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.

ListLifecyclePolicies

result=result = result=client->listLifecyclePolicies([/* ... /]); promise=promise = promise=client->listLifecyclePoliciesAsync([/ ... */]);

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Parameter Syntax

result=result = result=client->listLifecyclePolicies([ 'maxResults' => , 'nextToken' => '', 'resources' => ['', ...], 'type' => 'retention', // REQUIRED ]);

Parameter Details

Members

maxResults

An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.

nextToken

If your initial ListLifecyclePolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListLifecyclePolicies operations, which returns results in the next page.

resources

Resource filters that policies can apply to. Currently, the only supported resource type is index.

type

Required: Yes

Type: string

The type of lifecycle policy.

Result Syntax

[ 'lifecyclePolicySummaries' => [ [ 'createdDate' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policyVersion' => '', 'type' => 'retention', ], // ... ], 'nextToken' => '', ]

Result Details

Members

lifecyclePolicySummaries

Type: Array of LifecyclePolicySummary structures

Details about the requested lifecycle policies.

nextToken

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=result = result=client->listSecurityConfigs([/* ... /]); promise=promise = promise=client->listSecurityConfigsAsync([/ ... */]);

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->listSecurityConfigs([ 'maxResults' => , 'nextToken' => '', 'type' => 'saml|iamidentitycenter', // REQUIRED ]);

Parameter Details

Members

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

nextToken

If your initial ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.

type

Required: Yes

Type: string

The type of security configuration.

Result Syntax

[ 'nextToken' => '', 'securityConfigSummaries' => [ [ 'configVersion' => '', 'createdDate' => , 'description' => '', 'id' => '', 'lastModifiedDate' => , 'type' => 'saml|iamidentitycenter', ], // ... ], ]

Result Details

Members

nextToken

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=result = result=client->listSecurityPolicies([/* ... /]); promise=promise = promise=client->listSecurityPoliciesAsync([/ ... */]);

Returns information about configured OpenSearch Serverless security policies.

Parameter Syntax

result=result = result=client->listSecurityPolicies([ 'maxResults' => , 'nextToken' => '', 'resource' => ['', ...], 'type' => 'encryption|network', // REQUIRED ]);

Parameter Details

Members

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

nextToken

If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.

resource

Resource filters (can be collection or indexes) that policies can apply to.

type

Required: Yes

Type: string

The type of policy.

Result Syntax

[ 'nextToken' => '', 'securityPolicySummaries' => [ [ 'createdDate' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policyVersion' => '', 'type' => 'encryption|network', ], // ... ], ]

Result Details

Members

nextToken

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=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

Parameter Syntax

result=result = result=client->listTagsForResource([ 'resourceArn' => '', // 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 DELETING state), and must be owned by the account ID included in the request.

Result Syntax

[ 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], ]

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=result = result=client->listVpcEndpoints([/* ... /]); promise=promise = 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=result = result=client->listVpcEndpoints([ 'maxResults' => , 'nextToken' => '', 'vpcEndpointFilters' => [ 'status' => 'PENDING|DELETING|ACTIVE|FAILED', ], ]);

Parameter Details

Members

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

nextToken

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, 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, and FAILED.

Result Syntax

[ 'nextToken' => '', 'vpcEndpointSummaries' => [ [ 'id' => '', 'name' => '', 'status' => 'PENDING|DELETING|ACTIVE|FAILED', ], // ... ], ]

Result Details

Members

nextToken

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=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

Parameter Syntax

result=result = result=client->tagResource([ 'resourceArn' => '', // REQUIRED 'tags' => [ // REQUIRED [ 'key' => '', // REQUIRED 'value' => '', // 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 DELETING state), 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

The results for this operation are always empty.

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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

UntagResource

result=result = result=client->untagResource([/* ... /]); promise=promise = 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=result = result=client->untagResource([ 'resourceArn' => '', // REQUIRED 'tagKeys' => ['', ...], // 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 DELETING state), 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

The results for this operation are always empty.

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=result = result=client->updateAccessPolicy([/* ... /]); promise=promise = promise=client->updateAccessPolicyAsync([/ ... */]);

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->updateAccessPolicy([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'policy' => '', 'policyVersion' => '', // REQUIRED 'type' => 'data', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

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

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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', '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=result = result=client->updateAccountSettings([/* ... /]); promise=promise = 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=result = result=client->updateAccountSettings([ 'capacityLimits' => [ 'maxIndexingCapacityInOCU' => , 'maxSearchCapacityInOCU' => , ], ]);

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' => , 'maxSearchCapacityInOCU' => , ], ], ]

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=result = result=client->updateCollection([/* ... /]); promise=promise = promise=client->updateCollectionAsync([/ ... */]);

Updates an OpenSearch Serverless collection.

Parameter Syntax

result=result = result=client->updateCollection([ 'clientToken' => '', 'description' => '', 'id' => '', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

A description of the collection.

Required: Yes

Type: string

The unique identifier of the collection.

Result Syntax

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.

UpdateLifecyclePolicy

result=result = result=client->updateLifecyclePolicy([/* ... /]); promise=promise = promise=client->updateLifecyclePolicyAsync([/ ... */]);

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

Parameter Syntax

result=result = result=client->updateLifecyclePolicy([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'policy' => '', 'policyVersion' => '', // REQUIRED 'type' => 'retention', // REQUIRED ]);

Parameter Details

Members

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request.

description

A description of the lifecycle policy.

name

Required: Yes

Type: string

The name of the policy.

policy

The JSON policy document to use as the content for the lifecycle policy.

policyVersion

Required: Yes

Type: string

The version of the policy being updated.

type

Required: Yes

Type: string

The type of lifecycle policy.

Result Syntax

[ 'lifecyclePolicyDetail' => [ 'createdDate' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', 'type' => 'retention', ], ]

Result Details

Members

lifecyclePolicyDetail

Type: LifecyclePolicyDetail structure

Details about the updated lifecycle 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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

UpdateSecurityConfig

result=result = result=client->updateSecurityConfig([/* ... /]); promise=promise = promise=client->updateSecurityConfigAsync([/ ... */]);

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Parameter Syntax

result=result = result=client->updateSecurityConfig([ 'clientToken' => '', 'configVersion' => '', // REQUIRED 'description' => '', 'iamIdentityCenterOptionsUpdates' => [ 'groupAttribute' => 'GroupId|GroupName', 'userAttribute' => 'UserId|UserName|Email', ], 'id' => '', // REQUIRED 'samlOptions' => [ 'groupAttribute' => '', 'metadata' => '', // REQUIRED 'openSearchServerlessEntityId' => '', 'sessionTimeout' => , 'userAttribute' => '', ], ]);

Parameter Details

Members

clientToken

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 GetSecurityPolicy command.

description

A description of the security configuration.

iamIdentityCenterOptionsUpdates

Describes IAM Identity Center options in the form of a key-value map.

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

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=result = result=client->updateSecurityPolicy([/* ... /]); promise=promise = 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=result = result=client->updateSecurityPolicy([ 'clientToken' => '', 'description' => '', 'name' => '', // REQUIRED 'policy' => '', 'policyVersion' => '', // REQUIRED 'type' => 'encryption|network', // REQUIRED ]);

Parameter Details

Members

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

description

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

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' => , 'description' => '', 'lastModifiedDate' => , 'name' => '', 'policy' => [ ], 'policyVersion' => '', '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.

Thrown when you attempt to create more resources than the service allows based on service quotas.

UpdateVpcEndpoint

result=result = result=client->updateVpcEndpoint([/* ... /]); promise=promise = 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=result = result=client->updateVpcEndpoint([ 'addSecurityGroupIds' => ['', ...], 'addSubnetIds' => ['', ...], 'clientToken' => '', 'id' => '', // REQUIRED 'removeSecurityGroupIds' => ['', ...], 'removeSubnetIds' => ['', ...], ]);

Parameter Details

Members

addSecurityGroupIds

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

The ID of one or more subnets to add to the endpoint.

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

Required: Yes

Type: string

The unique identifier of the interface endpoint to update.

removeSecurityGroupIds

The unique identifiers of the security groups to remove from the endpoint.

removeSubnetIds

The unique identifiers of the subnets to remove from the endpoint.

Result Syntax

[ 'UpdateVpcEndpointDetail' => [ 'id' => '', 'lastModifiedDate' => , 'name' => '', 'securityGroupIds' => ['', ...], 'status' => 'PENDING|DELETING|ACTIVE|FAILED', 'subnetIds' => ['', ...], ], ]

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.