Long createdDate
The date the policy was created.
String description
The description of the policy.
Long lastModifiedDate
The timestamp of when the policy was last modified.
String name
The name of the policy.
String policyVersion
The version of the policy.
String type
The type of access policy.
Long dataPolicyCount
The number of data access policies in the current account.
Long createdDate
The Epoch time when the access policy was created.
String description
The description of the access policy.
Long lastModifiedDate
The date and time when the collection was last modified.
String name
The name of the access policy.
String policyVersion
The version of the policy.
String type
The type of access policy. Currently the only available type is data
.
CapacityLimits capacityLimits
List<E> ids
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.
List<E> names
A list of collection names. You can't provide names and IDs in the same request.
String arn
The Amazon Resource Name (ARN) of the collection.
String collectionEndpoint
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
Long createdDate
The Epoch time when the collection was created.
String dashboardEndpoint
Collection-specific endpoint used to access OpenSearch Dashboards.
String description
A description of the collection.
String id
A unique identifier for the collection.
String kmsKeyArn
The ARN of the Amazon Web Services KMS key used to encrypt the collection.
Long lastModifiedDate
The date and time when the collection was last modified.
String name
The name of the collection.
String status
The current status of the collection.
String type
The type of collection.
String errorCode
The error code for the request. For example, NOT_FOUND
.
String errorMessage
A description of the error. For example, The specified Collection is not found.
String id
If the request contains collection IDs, the response includes the IDs provided in the request.
String name
If the request contains collection names, the response includes the names provided in the request.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String description
A description of the policy. Typically used to store information about the permissions defined in the policy.
String name
The name of the policy.
String policy
The JSON policy document to use as the content for the policy.
String type
The type of policy.
AccessPolicyDetail accessPolicyDetail
Details about the created access policy.
String arn
The Amazon Resource Name (ARN) of the collection.
Long createdDate
The Epoch time when the collection was created.
String description
A description of the collection.
String id
The unique identifier of the collection.
String kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
Long lastModifiedDate
The date and time when the collection was last modified.
String name
The name of the collection.
String status
The current status of the collection.
String type
The type of collection.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String description
Description of the collection.
String name
Name of the collection.
List<E> tags
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
String type
The type of collection.
CreateCollectionDetail createCollectionDetail
Details about the collection.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String description
A description of the security configuration.
String name
The name of the security configuration.
SamlConfigOptions samlOptions
Describes SAML options in in the form of a key-value map.
String type
The type of security configuration.
SecurityConfigDetail securityConfigDetail
Details about the created security configuration.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String description
A description of the policy. Typically used to store information about the permissions defined in the policy.
String name
The name of the policy.
String policy
The JSON policy document to use as the content for the new policy.
String type
The type of security policy.
SecurityPolicyDetail securityPolicyDetail
Details about the created security policy.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String name
The name of the interface endpoint.
List<E> 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.
List<E> subnetIds
The ID of one or more subnets from which you'll access OpenSearch Serverless.
String vpcId
The ID of the VPC from which you'll access OpenSearch Serverless.
CreateVpcEndpointDetail createVpcEndpointDetail
Details about the created interface VPC endpoint.
String clientToken
A unique, case-sensitive identifier to ensure idempotency of the request.
String id
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.
DeleteCollectionDetail deleteCollectionDetail
Details of the deleted collection.
DeleteVpcEndpointDetail deleteVpcEndpointDetail
Details about the deleted endpoint.
AccessPolicyDetail accessPolicyDetail
Details about the requested access policy.
AccountSettingsDetail accountSettingsDetail
OpenSearch Serverless-related details for the current account.
AccessPolicyStats accessPolicyStats
Information about the data access policies in your account.
SecurityConfigStats securityConfigStats
Information about the security configurations in your account.
SecurityPolicyStats securityPolicyStats
Information about the security policies in your account.
Long totalPolicyCount
The total number of OpenSearch Serverless security policies and configurations in your account.
String id
The unique identifier of the security configuration.
SecurityConfigDetail securityConfigDetail
Details of the requested security configuration.
SecurityPolicyDetail securityPolicyDetail
Details about the requested security policy.
Integer 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.
String 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.
List<E> resource
Resource filters (can be collection or indexes) that policies can apply to.
String type
The type of access policy.
List<E> accessPolicySummaries
Details about the requested access policies.
String 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.
CollectionFilters collectionFilters
List of filter names and values that you can use for requests.
Integer maxResults
The maximum number of results to return. Default is 20. You can use nextToken
to get the next page
of results.
String 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.
List<E> collectionSummaries
Details about each collection.
String 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.
Integer 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.
String 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.
String type
The type of security configuration.
String 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.
List<E> securityConfigSummaries
Details about the security configurations in your account.
Integer 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.
String 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.
List<E> resource
Resource filters (can be collection or indexes) that policies can apply to.
String type
The type of policy.
String 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.
List<E> securityPolicySummaries
Details about the security policies in your account.
String resourceArn
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.
Integer 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.
String 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 vpcEndpointFilters
Filter the results according to the current status of the VPC endpoint. Possible statuses are
CREATING
, DELETING
, UPDATING
, ACTIVE
, and FAILED
.
String 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.
List<E> vpcEndpointSummaries
Details about each VPC endpoint, including the name and current status.
String groupAttribute
The group attribute for this SAML integration.
String metadata
The XML IdP metadata file generated from your identity provider.
Integer sessionTimeout
The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
String userAttribute
A user attribute for this SAML integration.
String configVersion
The version of the security configuration.
Long createdDate
The date the configuration was created.
String description
The description of the security configuration.
String id
The unique identifier of the security configuration.
Long lastModifiedDate
The timestamp of when the configuration was last modified.
SamlConfigOptions samlOptions
SAML options for the security configuration in the form of a key-value map.
String type
The type of security configuration.
Long samlConfigCount
The number of security configurations in the current account.
String configVersion
The version of the security configuration.
Long createdDate
The Epoch time when the security configuration was created.
String description
The description of the security configuration.
String id
The unique identifier of the security configuration.
Long lastModifiedDate
The timestamp of when the configuration was last modified.
String type
The type of security configuration.
Long createdDate
The date the policy was created.
String description
The description of the security policy.
Long lastModifiedDate
The timestamp of when the policy was last modified.
String name
The name of the policy.
String policyVersion
The version of the policy.
String type
The type of security policy.
Long createdDate
The date the policy was created.
String description
The description of the security policy.
Long lastModifiedDate
The timestamp of when the policy was last modified.
String name
The name of the policy.
String policyVersion
The version of the policy.
String type
The type of security policy.
String resourceArn
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.
List<E> tags
A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.
String resourceArn
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.
List<E> tagKeys
The tag or set of tags to remove from the resource. All tag keys in the request must be unique.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String description
A description of the policy. Typically used to store information about the permissions defined in the policy.
String name
The name of the policy.
String policy
The JSON policy document to use as the content for the policy.
String policyVersion
The version of the policy being updated.
String type
The type of policy.
AccessPolicyDetail accessPolicyDetail
Details about the updated access policy.
CapacityLimits capacityLimits
AccountSettingsDetail accountSettingsDetail
OpenSearch Serverless-related settings for the current Amazon Web Services account.
String arn
The Amazon Resource Name (ARN) of the collection.
Long createdDate
The date and time when the collection was created.
String description
The description of the collection.
String id
The unique identifier of the collection.
Long lastModifiedDate
The date and time when the collection was last modified.
String name
The name of the collection.
String status
The current status of the collection.
String type
The collection type.
UpdateCollectionDetail updateCollectionDetail
Details about the updated collection.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String configVersion
The version of the security configuration to be updated. You can find the most recent version of a security
configuration using the GetSecurityPolicy
command.
String description
A description of the security configuration.
String id
The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>
. For example, saml/123456789123/OKTADev
.
SamlConfigOptions samlOptions
SAML options in in the form of a key-value map.
SecurityConfigDetail securityConfigDetail
Details about the updated security configuration.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String description
A description of the policy. Typically used to store information about the permissions defined in the policy.
String name
The name of the policy.
String policy
The JSON policy document to use as the content for the new policy.
String policyVersion
The version of the policy being updated.
String type
The type of access policy.
SecurityPolicyDetail securityPolicyDetail
Details about the updated security policy.
String id
The unique identifier of the endpoint.
Long lastModifiedDate
The timestamp of when the endpoint was last modified.
String name
The name of the endpoint.
List<E> 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.
String status
The current status of the endpoint update process.
List<E> subnetIds
The ID of the subnets from which you access OpenSearch Serverless.
List<E> 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.
List<E> addSubnetIds
The ID of one or more subnets to add to the endpoint.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
String id
The unique identifier of the interface endpoint to update.
List<E> removeSecurityGroupIds
The unique identifiers of the security groups to remove from the endpoint.
List<E> removeSubnetIds
The unique identifiers of the subnets to remove from the endpoint.
UpdateVpcEndpointDetail updateVpcEndpointDetail
Details about the updated VPC endpoint.
Long createdDate
The date the endpoint was created.
String id
The unique identifier of the endpoint.
String name
The name of the endpoint.
List<E> 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.
String status
The current status of the endpoint.
List<E> subnetIds
The ID of the subnets from which you access OpenSearch Serverless.
String vpcId
The ID of the VPC from which you access OpenSearch Serverless
String status
The current status of the endpoint.
Copyright © 2023. All rights reserved.