| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.OpenSearchServerless
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BatchGetCollection
- BatchGetVpcEndpoint
- CreateAccessPolicy
- CreateCollection
- CreateSecurityConfig
- CreateSecurityPolicy
- CreateVpcEndpoint
- DeleteAccessPolicy
- DeleteCollection
- DeleteSecurityConfig
- DeleteSecurityPolicy
- DeleteVpcEndpoint
- GetAccessPolicy
- GetAccountSettings
- GetPoliciesStats
- GetSecurityConfig
- GetSecurityPolicy
- ListAccessPolicies
- ListCollections
- ListSecurityConfigs
- ListSecurityPolicies
- ListTagsForResource
- ListVpcEndpoints
- TagResource
- UntagResource
- UpdateAccessPolicy
- UpdateAccountSettings
- UpdateCollection
- UpdateSecurityConfig
- UpdateSecurityPolicy
- UpdateVpcEndpoint
- Types
- AccessPolicyType
- CollectionStatus
- CollectionType
- SecurityConfigType
- SecurityPolicyType
- VpcEndpointStatus
- AccessPolicyDetail
- AccessPolicyStats
- AccessPolicySummary
- AccountSettingsDetail
- CapacityLimits
- CollectionDetail
- CollectionErrorDetail
- CollectionFilters
- CollectionSummary
- CreateCollectionDetail
- CreateVpcEndpointDetail
- DeleteCollectionDetail
- DeleteVpcEndpointDetail
- Document
- SamlConfigOptions
- SecurityConfigDetail
- SecurityConfigStats
- SecurityConfigSummary
- SecurityPolicyDetail
- SecurityPolicyStats
- SecurityPolicySummary
- Tag
- UpdateCollectionDetail
- UpdateVpcEndpointDetail
- VpcEndpointDetail
- VpcEndpointErrorDetail
- VpcEndpointFilters
- VpcEndpointSummary
Description
Derived from API version 2021-11-01 of the AWS service descriptions, licensed under Apache 2.0.
Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.
OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.
To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BatchGetCollection = BatchGetCollection' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text))
- newBatchGetCollection :: BatchGetCollection
- data BatchGetCollectionResponse = BatchGetCollectionResponse' (Maybe [CollectionDetail]) (Maybe [CollectionErrorDetail]) Int
- newBatchGetCollectionResponse :: Int -> BatchGetCollectionResponse
- data BatchGetVpcEndpoint = BatchGetVpcEndpoint' (NonEmpty Text)
- newBatchGetVpcEndpoint :: NonEmpty Text -> BatchGetVpcEndpoint
- data BatchGetVpcEndpointResponse = BatchGetVpcEndpointResponse' (Maybe [VpcEndpointDetail]) (Maybe [VpcEndpointErrorDetail]) Int
- newBatchGetVpcEndpointResponse :: Int -> BatchGetVpcEndpointResponse
- data CreateAccessPolicy = CreateAccessPolicy' (Maybe Text) (Maybe Text) Text Text AccessPolicyType
- newCreateAccessPolicy :: Text -> Text -> AccessPolicyType -> CreateAccessPolicy
- data CreateAccessPolicyResponse = CreateAccessPolicyResponse' (Maybe AccessPolicyDetail) Int
- newCreateAccessPolicyResponse :: Int -> CreateAccessPolicyResponse
- data CreateCollection = CreateCollection' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe CollectionType) Text
- newCreateCollection :: Text -> CreateCollection
- data CreateCollectionResponse = CreateCollectionResponse' (Maybe CreateCollectionDetail) Int
- newCreateCollectionResponse :: Int -> CreateCollectionResponse
- data CreateSecurityConfig = CreateSecurityConfig' (Maybe Text) (Maybe Text) (Maybe SamlConfigOptions) Text SecurityConfigType
- newCreateSecurityConfig :: Text -> SecurityConfigType -> CreateSecurityConfig
- data CreateSecurityConfigResponse = CreateSecurityConfigResponse' (Maybe SecurityConfigDetail) Int
- newCreateSecurityConfigResponse :: Int -> CreateSecurityConfigResponse
- data CreateSecurityPolicy = CreateSecurityPolicy' (Maybe Text) (Maybe Text) Text Text SecurityPolicyType
- newCreateSecurityPolicy :: Text -> Text -> SecurityPolicyType -> CreateSecurityPolicy
- data CreateSecurityPolicyResponse = CreateSecurityPolicyResponse' (Maybe SecurityPolicyDetail) Int
- newCreateSecurityPolicyResponse :: Int -> CreateSecurityPolicyResponse
- data CreateVpcEndpoint = CreateVpcEndpoint' (Maybe Text) (Maybe (NonEmpty Text)) Text (NonEmpty Text) Text
- newCreateVpcEndpoint :: Text -> NonEmpty Text -> Text -> CreateVpcEndpoint
- data CreateVpcEndpointResponse = CreateVpcEndpointResponse' (Maybe CreateVpcEndpointDetail) Int
- newCreateVpcEndpointResponse :: Int -> CreateVpcEndpointResponse
- data DeleteAccessPolicy = DeleteAccessPolicy' (Maybe Text) Text AccessPolicyType
- newDeleteAccessPolicy :: Text -> AccessPolicyType -> DeleteAccessPolicy
- data DeleteAccessPolicyResponse = DeleteAccessPolicyResponse' Int
- newDeleteAccessPolicyResponse :: Int -> DeleteAccessPolicyResponse
- data DeleteCollection = DeleteCollection' (Maybe Text) Text
- newDeleteCollection :: Text -> DeleteCollection
- data DeleteCollectionResponse = DeleteCollectionResponse' (Maybe DeleteCollectionDetail) Int
- newDeleteCollectionResponse :: Int -> DeleteCollectionResponse
- data DeleteSecurityConfig = DeleteSecurityConfig' (Maybe Text) Text
- newDeleteSecurityConfig :: Text -> DeleteSecurityConfig
- data DeleteSecurityConfigResponse = DeleteSecurityConfigResponse' Int
- newDeleteSecurityConfigResponse :: Int -> DeleteSecurityConfigResponse
- data DeleteSecurityPolicy = DeleteSecurityPolicy' (Maybe Text) Text SecurityPolicyType
- newDeleteSecurityPolicy :: Text -> SecurityPolicyType -> DeleteSecurityPolicy
- data DeleteSecurityPolicyResponse = DeleteSecurityPolicyResponse' Int
- newDeleteSecurityPolicyResponse :: Int -> DeleteSecurityPolicyResponse
- data DeleteVpcEndpoint = DeleteVpcEndpoint' (Maybe Text) Text
- newDeleteVpcEndpoint :: Text -> DeleteVpcEndpoint
- data DeleteVpcEndpointResponse = DeleteVpcEndpointResponse' (Maybe DeleteVpcEndpointDetail) Int
- newDeleteVpcEndpointResponse :: Int -> DeleteVpcEndpointResponse
- data GetAccessPolicy = GetAccessPolicy' Text AccessPolicyType
- newGetAccessPolicy :: Text -> AccessPolicyType -> GetAccessPolicy
- data GetAccessPolicyResponse = GetAccessPolicyResponse' (Maybe AccessPolicyDetail) Int
- newGetAccessPolicyResponse :: Int -> GetAccessPolicyResponse
- data GetAccountSettings = GetAccountSettings' {
- newGetAccountSettings :: GetAccountSettings
- data GetAccountSettingsResponse = GetAccountSettingsResponse' (Maybe AccountSettingsDetail) Int
- newGetAccountSettingsResponse :: Int -> GetAccountSettingsResponse
- data GetPoliciesStats = GetPoliciesStats' {
- newGetPoliciesStats :: GetPoliciesStats
- data GetPoliciesStatsResponse = GetPoliciesStatsResponse' (Maybe AccessPolicyStats) (Maybe SecurityConfigStats) (Maybe SecurityPolicyStats) (Maybe Integer) Int
- newGetPoliciesStatsResponse :: Int -> GetPoliciesStatsResponse
- data GetSecurityConfig = GetSecurityConfig' Text
- newGetSecurityConfig :: Text -> GetSecurityConfig
- data GetSecurityConfigResponse = GetSecurityConfigResponse' (Maybe SecurityConfigDetail) Int
- newGetSecurityConfigResponse :: Int -> GetSecurityConfigResponse
- data GetSecurityPolicy = GetSecurityPolicy' Text SecurityPolicyType
- newGetSecurityPolicy :: Text -> SecurityPolicyType -> GetSecurityPolicy
- data GetSecurityPolicyResponse = GetSecurityPolicyResponse' (Maybe SecurityPolicyDetail) Int
- newGetSecurityPolicyResponse :: Int -> GetSecurityPolicyResponse
- data ListAccessPolicies = ListAccessPolicies' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) AccessPolicyType
- newListAccessPolicies :: AccessPolicyType -> ListAccessPolicies
- data ListAccessPoliciesResponse = ListAccessPoliciesResponse' (Maybe [AccessPolicySummary]) (Maybe Text) Int
- newListAccessPoliciesResponse :: Int -> ListAccessPoliciesResponse
- data ListCollections = ListCollections' (Maybe CollectionFilters) (Maybe Natural) (Maybe Text)
- newListCollections :: ListCollections
- data ListCollectionsResponse = ListCollectionsResponse' (Maybe [CollectionSummary]) (Maybe Text) Int
- newListCollectionsResponse :: Int -> ListCollectionsResponse
- data ListSecurityConfigs = ListSecurityConfigs' (Maybe Natural) (Maybe Text) SecurityConfigType
- newListSecurityConfigs :: SecurityConfigType -> ListSecurityConfigs
- data ListSecurityConfigsResponse = ListSecurityConfigsResponse' (Maybe Text) (Maybe [SecurityConfigSummary]) Int
- newListSecurityConfigsResponse :: Int -> ListSecurityConfigsResponse
- data ListSecurityPolicies = ListSecurityPolicies' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) SecurityPolicyType
- newListSecurityPolicies :: SecurityPolicyType -> ListSecurityPolicies
- data ListSecurityPoliciesResponse = ListSecurityPoliciesResponse' (Maybe Text) (Maybe [SecurityPolicySummary]) Int
- newListSecurityPoliciesResponse :: Int -> ListSecurityPoliciesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListVpcEndpoints = ListVpcEndpoints' (Maybe Natural) (Maybe Text) (Maybe VpcEndpointFilters)
- newListVpcEndpoints :: ListVpcEndpoints
- data ListVpcEndpointsResponse = ListVpcEndpointsResponse' (Maybe Text) (Maybe [VpcEndpointSummary]) Int
- newListVpcEndpointsResponse :: Int -> ListVpcEndpointsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAccessPolicy = UpdateAccessPolicy' (Maybe Text) (Maybe Text) (Maybe Text) Text Text AccessPolicyType
- newUpdateAccessPolicy :: Text -> Text -> AccessPolicyType -> UpdateAccessPolicy
- data UpdateAccessPolicyResponse = UpdateAccessPolicyResponse' (Maybe AccessPolicyDetail) Int
- newUpdateAccessPolicyResponse :: Int -> UpdateAccessPolicyResponse
- data UpdateAccountSettings = UpdateAccountSettings' (Maybe CapacityLimits)
- newUpdateAccountSettings :: UpdateAccountSettings
- data UpdateAccountSettingsResponse = UpdateAccountSettingsResponse' (Maybe AccountSettingsDetail) Int
- newUpdateAccountSettingsResponse :: Int -> UpdateAccountSettingsResponse
- data UpdateCollection = UpdateCollection' (Maybe Text) (Maybe Text) Text
- newUpdateCollection :: Text -> UpdateCollection
- data UpdateCollectionResponse = UpdateCollectionResponse' (Maybe UpdateCollectionDetail) Int
- newUpdateCollectionResponse :: Int -> UpdateCollectionResponse
- data UpdateSecurityConfig = UpdateSecurityConfig' (Maybe Text) (Maybe Text) (Maybe SamlConfigOptions) Text Text
- newUpdateSecurityConfig :: Text -> Text -> UpdateSecurityConfig
- data UpdateSecurityConfigResponse = UpdateSecurityConfigResponse' (Maybe SecurityConfigDetail) Int
- newUpdateSecurityConfigResponse :: Int -> UpdateSecurityConfigResponse
- data UpdateSecurityPolicy = UpdateSecurityPolicy' (Maybe Text) (Maybe Text) (Maybe Text) Text Text SecurityPolicyType
- newUpdateSecurityPolicy :: Text -> Text -> SecurityPolicyType -> UpdateSecurityPolicy
- data UpdateSecurityPolicyResponse = UpdateSecurityPolicyResponse' (Maybe SecurityPolicyDetail) Int
- newUpdateSecurityPolicyResponse :: Int -> UpdateSecurityPolicyResponse
- data UpdateVpcEndpoint = UpdateVpcEndpoint' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text
- newUpdateVpcEndpoint :: Text -> UpdateVpcEndpoint
- data UpdateVpcEndpointResponse = UpdateVpcEndpointResponse' (Maybe UpdateVpcEndpointDetail) Int
- newUpdateVpcEndpointResponse :: Int -> UpdateVpcEndpointResponse
- newtype AccessPolicyType where
- AccessPolicyType' { }
- pattern AccessPolicyType_Data :: AccessPolicyType
- newtype CollectionStatus where
- CollectionStatus' { }
- pattern CollectionStatus_ACTIVE :: CollectionStatus
- pattern CollectionStatus_CREATING :: CollectionStatus
- pattern CollectionStatus_DELETING :: CollectionStatus
- pattern CollectionStatus_FAILED :: CollectionStatus
- newtype CollectionType where
- CollectionType' { }
- pattern CollectionType_SEARCH :: CollectionType
- pattern CollectionType_TIMESERIES :: CollectionType
- newtype SecurityConfigType where
- newtype SecurityPolicyType where
- newtype VpcEndpointStatus where
- VpcEndpointStatus' { }
- pattern VpcEndpointStatus_ACTIVE :: VpcEndpointStatus
- pattern VpcEndpointStatus_DELETING :: VpcEndpointStatus
- pattern VpcEndpointStatus_FAILED :: VpcEndpointStatus
- pattern VpcEndpointStatus_PENDING :: VpcEndpointStatus
- data AccessPolicyDetail = AccessPolicyDetail' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Document) (Maybe Text) (Maybe AccessPolicyType)
- newAccessPolicyDetail :: AccessPolicyDetail
- data AccessPolicyStats = AccessPolicyStats' (Maybe Integer)
- newAccessPolicyStats :: AccessPolicyStats
- data AccessPolicySummary = AccessPolicySummary' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe AccessPolicyType)
- newAccessPolicySummary :: AccessPolicySummary
- data AccountSettingsDetail = AccountSettingsDetail' (Maybe CapacityLimits)
- newAccountSettingsDetail :: AccountSettingsDetail
- data CapacityLimits = CapacityLimits' (Maybe Natural) (Maybe Natural)
- newCapacityLimits :: CapacityLimits
- data CollectionDetail = CollectionDetail' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe CollectionStatus) (Maybe CollectionType)
- newCollectionDetail :: CollectionDetail
- data CollectionErrorDetail = CollectionErrorDetail' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCollectionErrorDetail :: CollectionErrorDetail
- data CollectionFilters = CollectionFilters' (Maybe Text) (Maybe CollectionStatus)
- newCollectionFilters :: CollectionFilters
- data CollectionSummary = CollectionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CollectionStatus)
- newCollectionSummary :: CollectionSummary
- data CreateCollectionDetail = CreateCollectionDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe CollectionStatus) (Maybe CollectionType)
- newCreateCollectionDetail :: CreateCollectionDetail
- data CreateVpcEndpointDetail = CreateVpcEndpointDetail' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus)
- newCreateVpcEndpointDetail :: CreateVpcEndpointDetail
- data DeleteCollectionDetail = DeleteCollectionDetail' (Maybe Text) (Maybe Text) (Maybe CollectionStatus)
- newDeleteCollectionDetail :: DeleteCollectionDetail
- data DeleteVpcEndpointDetail = DeleteVpcEndpointDetail' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus)
- newDeleteVpcEndpointDetail :: DeleteVpcEndpointDetail
- data Document = Document' {
- newDocument :: Document
- data SamlConfigOptions = SamlConfigOptions' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newSamlConfigOptions :: Text -> SamlConfigOptions
- data SecurityConfigDetail = SecurityConfigDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe SamlConfigOptions) (Maybe SecurityConfigType)
- newSecurityConfigDetail :: SecurityConfigDetail
- data SecurityConfigStats = SecurityConfigStats' (Maybe Integer)
- newSecurityConfigStats :: SecurityConfigStats
- data SecurityConfigSummary = SecurityConfigSummary' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe SecurityConfigType)
- newSecurityConfigSummary :: SecurityConfigSummary
- data SecurityPolicyDetail = SecurityPolicyDetail' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Document) (Maybe Text) (Maybe SecurityPolicyType)
- newSecurityPolicyDetail :: SecurityPolicyDetail
- data SecurityPolicyStats = SecurityPolicyStats' (Maybe Integer) (Maybe Integer)
- newSecurityPolicyStats :: SecurityPolicyStats
- data SecurityPolicySummary = SecurityPolicySummary' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe SecurityPolicyType)
- newSecurityPolicySummary :: SecurityPolicySummary
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data UpdateCollectionDetail = UpdateCollectionDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe CollectionStatus) (Maybe CollectionType)
- newUpdateCollectionDetail :: UpdateCollectionDetail
- data UpdateVpcEndpointDetail = UpdateVpcEndpointDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe VpcEndpointStatus) (Maybe (NonEmpty Text))
- newUpdateVpcEndpointDetail :: UpdateVpcEndpointDetail
- data VpcEndpointDetail = VpcEndpointDetail' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe VpcEndpointStatus) (Maybe (NonEmpty Text)) (Maybe Text)
- newVpcEndpointDetail :: VpcEndpointDetail
- data VpcEndpointErrorDetail = VpcEndpointErrorDetail' (Maybe Text) (Maybe Text) (Maybe Text)
- newVpcEndpointErrorDetail :: VpcEndpointErrorDetail
- data VpcEndpointFilters = VpcEndpointFilters' (Maybe VpcEndpointStatus)
- newVpcEndpointFilters :: VpcEndpointFilters
- data VpcEndpointSummary = VpcEndpointSummary' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus)
- newVpcEndpointSummary :: VpcEndpointSummary
Service Configuration
defaultService :: Service Source #
API version 2021-11-01 of the Amazon OpenSearch Service Serverless SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by OpenSearchServerless.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
When creating a collection, thrown when a collection with the same name already exists or is being created. When deleting a collection, thrown when the collection is not in the ACTIVE or FAILED state.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Thrown when an error internal to the service occurs while processing a request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Thrown when accessing or deleting a resource that does not exist.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Thrown when the HTTP request contains invalid input or is missing required input.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchGetCollection
data BatchGetCollection Source #
See: newBatchGetCollection smart constructor.
Instances
newBatchGetCollection :: BatchGetCollection Source #
Create a value of BatchGetCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ids:BatchGetCollection', batchGetCollection_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.
$sel:names:BatchGetCollection', batchGetCollection_names - A list of collection names. You can't provide names and IDs in the same
request.
data BatchGetCollectionResponse Source #
See: newBatchGetCollectionResponse smart constructor.
Constructors
| BatchGetCollectionResponse' (Maybe [CollectionDetail]) (Maybe [CollectionErrorDetail]) Int |
Instances
newBatchGetCollectionResponse Source #
Create a value of BatchGetCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionDetails:BatchGetCollectionResponse', batchGetCollectionResponse_collectionDetails - Details about each collection.
$sel:collectionErrorDetails:BatchGetCollectionResponse', batchGetCollectionResponse_collectionErrorDetails - Error information for the request.
$sel:httpStatus:BatchGetCollectionResponse', batchGetCollectionResponse_httpStatus - The response's http status code.
BatchGetVpcEndpoint
data BatchGetVpcEndpoint Source #
See: newBatchGetVpcEndpoint smart constructor.
Constructors
| BatchGetVpcEndpoint' (NonEmpty Text) |
Instances
newBatchGetVpcEndpoint Source #
Arguments
| :: NonEmpty Text | |
| -> BatchGetVpcEndpoint |
Create a value of BatchGetVpcEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ids:BatchGetVpcEndpoint', batchGetVpcEndpoint_ids - A list of VPC endpoint identifiers.
data BatchGetVpcEndpointResponse Source #
See: newBatchGetVpcEndpointResponse smart constructor.
Constructors
| BatchGetVpcEndpointResponse' (Maybe [VpcEndpointDetail]) (Maybe [VpcEndpointErrorDetail]) Int |
Instances
newBatchGetVpcEndpointResponse Source #
Create a value of BatchGetVpcEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpcEndpointDetails:BatchGetVpcEndpointResponse', batchGetVpcEndpointResponse_vpcEndpointDetails - Details about the specified VPC endpoint.
$sel:vpcEndpointErrorDetails:BatchGetVpcEndpointResponse', batchGetVpcEndpointResponse_vpcEndpointErrorDetails - Error information for a failed request.
$sel:httpStatus:BatchGetVpcEndpointResponse', batchGetVpcEndpointResponse_httpStatus - The response's http status code.
CreateAccessPolicy
data CreateAccessPolicy Source #
See: newCreateAccessPolicy smart constructor.
Constructors
| CreateAccessPolicy' (Maybe Text) (Maybe Text) Text Text AccessPolicyType |
Instances
newCreateAccessPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> AccessPolicyType | |
| -> CreateAccessPolicy |
Create a value of CreateAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateAccessPolicy', createAccessPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
CreateAccessPolicy, createAccessPolicy_description - A description of the policy. Typically used to store information about
the permissions defined in the policy.
CreateAccessPolicy, createAccessPolicy_name - The name of the policy.
CreateAccessPolicy, createAccessPolicy_policy - The JSON policy document to use as the content for the policy.
CreateAccessPolicy, createAccessPolicy_type - The type of policy.
data CreateAccessPolicyResponse Source #
See: newCreateAccessPolicyResponse smart constructor.
Constructors
| CreateAccessPolicyResponse' (Maybe AccessPolicyDetail) Int |
Instances
newCreateAccessPolicyResponse Source #
Create a value of CreateAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPolicyDetail:CreateAccessPolicyResponse', createAccessPolicyResponse_accessPolicyDetail - Details about the created access policy.
$sel:httpStatus:CreateAccessPolicyResponse', createAccessPolicyResponse_httpStatus - The response's http status code.
CreateCollection
data CreateCollection Source #
See: newCreateCollection smart constructor.
Constructors
| CreateCollection' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe CollectionType) Text |
Instances
Arguments
| :: Text | |
| -> CreateCollection |
Create a value of CreateCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateCollection', createCollection_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
CreateCollection, createCollection_description - Description of the collection.
$sel:tags:CreateCollection', createCollection_tags - An arbitrary set of tags (key–value pairs) to associate with the
OpenSearch Serverless collection.
CreateCollection, createCollection_type - The type of collection.
CreateCollection, createCollection_name - Name of the collection.
data CreateCollectionResponse Source #
See: newCreateCollectionResponse smart constructor.
Constructors
| CreateCollectionResponse' (Maybe CreateCollectionDetail) Int |
Instances
newCreateCollectionResponse Source #
Create a value of CreateCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createCollectionDetail:CreateCollectionResponse', createCollectionResponse_createCollectionDetail - Details about the collection.
$sel:httpStatus:CreateCollectionResponse', createCollectionResponse_httpStatus - The response's http status code.
CreateSecurityConfig
data CreateSecurityConfig Source #
See: newCreateSecurityConfig smart constructor.
Constructors
| CreateSecurityConfig' (Maybe Text) (Maybe Text) (Maybe SamlConfigOptions) Text SecurityConfigType |
Instances
newCreateSecurityConfig Source #
Arguments
| :: Text | |
| -> SecurityConfigType | |
| -> CreateSecurityConfig |
Create a value of CreateSecurityConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateSecurityConfig', createSecurityConfig_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
CreateSecurityConfig, createSecurityConfig_description - A description of the security configuration.
CreateSecurityConfig, createSecurityConfig_samlOptions - Describes SAML options in in the form of a key-value map.
CreateSecurityConfig, createSecurityConfig_name - The name of the security configuration.
CreateSecurityConfig, createSecurityConfig_type - The type of security configuration.
data CreateSecurityConfigResponse Source #
See: newCreateSecurityConfigResponse smart constructor.
Constructors
| CreateSecurityConfigResponse' (Maybe SecurityConfigDetail) Int |
Instances
newCreateSecurityConfigResponse Source #
Create a value of CreateSecurityConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityConfigDetail:CreateSecurityConfigResponse', createSecurityConfigResponse_securityConfigDetail - Details about the created security configuration.
$sel:httpStatus:CreateSecurityConfigResponse', createSecurityConfigResponse_httpStatus - The response's http status code.
CreateSecurityPolicy
data CreateSecurityPolicy Source #
See: newCreateSecurityPolicy smart constructor.
Constructors
| CreateSecurityPolicy' (Maybe Text) (Maybe Text) Text Text SecurityPolicyType |
Instances
newCreateSecurityPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> SecurityPolicyType | |
| -> CreateSecurityPolicy |
Create a value of CreateSecurityPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateSecurityPolicy', createSecurityPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
CreateSecurityPolicy, createSecurityPolicy_description - A description of the policy. Typically used to store information about
the permissions defined in the policy.
CreateSecurityPolicy, createSecurityPolicy_name - The name of the policy.
CreateSecurityPolicy, createSecurityPolicy_policy - The JSON policy document to use as the content for the new policy.
CreateSecurityPolicy, createSecurityPolicy_type - The type of security policy.
data CreateSecurityPolicyResponse Source #
See: newCreateSecurityPolicyResponse smart constructor.
Constructors
| CreateSecurityPolicyResponse' (Maybe SecurityPolicyDetail) Int |
Instances
newCreateSecurityPolicyResponse Source #
Create a value of CreateSecurityPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityPolicyDetail:CreateSecurityPolicyResponse', createSecurityPolicyResponse_securityPolicyDetail - Details about the created security policy.
$sel:httpStatus:CreateSecurityPolicyResponse', createSecurityPolicyResponse_httpStatus - The response's http status code.
CreateVpcEndpoint
data CreateVpcEndpoint Source #
See: newCreateVpcEndpoint smart constructor.
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> Text | |
| -> CreateVpcEndpoint |
Create a value of CreateVpcEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateVpcEndpoint', createVpcEndpoint_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
CreateVpcEndpoint, createVpcEndpoint_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.
CreateVpcEndpoint, createVpcEndpoint_name - The name of the interface endpoint.
CreateVpcEndpoint, createVpcEndpoint_subnetIds - The ID of one or more subnets from which you'll access OpenSearch
Serverless.
CreateVpcEndpoint, createVpcEndpoint_vpcId - The ID of the VPC from which you'll access OpenSearch Serverless.
data CreateVpcEndpointResponse Source #
See: newCreateVpcEndpointResponse smart constructor.
Constructors
| CreateVpcEndpointResponse' (Maybe CreateVpcEndpointDetail) Int |
Instances
newCreateVpcEndpointResponse Source #
Create a value of CreateVpcEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createVpcEndpointDetail:CreateVpcEndpointResponse', createVpcEndpointResponse_createVpcEndpointDetail - Details about the created interface VPC endpoint.
$sel:httpStatus:CreateVpcEndpointResponse', createVpcEndpointResponse_httpStatus - The response's http status code.
DeleteAccessPolicy
data DeleteAccessPolicy Source #
See: newDeleteAccessPolicy smart constructor.
Constructors
| DeleteAccessPolicy' (Maybe Text) Text AccessPolicyType |
Instances
newDeleteAccessPolicy Source #
Create a value of DeleteAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteAccessPolicy', deleteAccessPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
DeleteAccessPolicy, deleteAccessPolicy_name - The name of the policy to delete.
DeleteAccessPolicy, deleteAccessPolicy_type - The type of policy.
data DeleteAccessPolicyResponse Source #
See: newDeleteAccessPolicyResponse smart constructor.
Constructors
| DeleteAccessPolicyResponse' Int |
Instances
newDeleteAccessPolicyResponse Source #
Create a value of DeleteAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAccessPolicyResponse', deleteAccessPolicyResponse_httpStatus - The response's http status code.
DeleteCollection
data DeleteCollection Source #
See: newDeleteCollection smart constructor.
Constructors
| DeleteCollection' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteCollection |
Create a value of DeleteCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteCollection', deleteCollection_clientToken - A unique, case-sensitive identifier to ensure idempotency of the
request.
DeleteCollection, deleteCollection_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.
data DeleteCollectionResponse Source #
See: newDeleteCollectionResponse smart constructor.
Constructors
| DeleteCollectionResponse' (Maybe DeleteCollectionDetail) Int |
Instances
newDeleteCollectionResponse Source #
Create a value of DeleteCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteCollectionDetail:DeleteCollectionResponse', deleteCollectionResponse_deleteCollectionDetail - Details of the deleted collection.
$sel:httpStatus:DeleteCollectionResponse', deleteCollectionResponse_httpStatus - The response's http status code.
DeleteSecurityConfig
data DeleteSecurityConfig Source #
See: newDeleteSecurityConfig smart constructor.
Constructors
| DeleteSecurityConfig' (Maybe Text) Text |
Instances
newDeleteSecurityConfig Source #
Arguments
| :: Text | |
| -> DeleteSecurityConfig |
Create a value of DeleteSecurityConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteSecurityConfig', deleteSecurityConfig_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
DeleteSecurityConfig, deleteSecurityConfig_id - The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example,
saml/123456789123/OKTADev.
data DeleteSecurityConfigResponse Source #
See: newDeleteSecurityConfigResponse smart constructor.
Constructors
| DeleteSecurityConfigResponse' Int |
Instances
newDeleteSecurityConfigResponse Source #
Create a value of DeleteSecurityConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSecurityConfigResponse', deleteSecurityConfigResponse_httpStatus - The response's http status code.
DeleteSecurityPolicy
data DeleteSecurityPolicy Source #
See: newDeleteSecurityPolicy smart constructor.
Constructors
| DeleteSecurityPolicy' (Maybe Text) Text SecurityPolicyType |
Instances
newDeleteSecurityPolicy Source #
Arguments
| :: Text | |
| -> SecurityPolicyType | |
| -> DeleteSecurityPolicy |
Create a value of DeleteSecurityPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteSecurityPolicy', deleteSecurityPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
DeleteSecurityPolicy, deleteSecurityPolicy_name - The name of the policy to delete.
DeleteSecurityPolicy, deleteSecurityPolicy_type - The type of policy.
data DeleteSecurityPolicyResponse Source #
See: newDeleteSecurityPolicyResponse smart constructor.
Constructors
| DeleteSecurityPolicyResponse' Int |
Instances
newDeleteSecurityPolicyResponse Source #
Create a value of DeleteSecurityPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSecurityPolicyResponse', deleteSecurityPolicyResponse_httpStatus - The response's http status code.
DeleteVpcEndpoint
data DeleteVpcEndpoint Source #
See: newDeleteVpcEndpoint smart constructor.
Constructors
| DeleteVpcEndpoint' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteVpcEndpoint |
Create a value of DeleteVpcEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteVpcEndpoint', deleteVpcEndpoint_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
DeleteVpcEndpoint, deleteVpcEndpoint_id - The VPC endpoint identifier.
data DeleteVpcEndpointResponse Source #
See: newDeleteVpcEndpointResponse smart constructor.
Constructors
| DeleteVpcEndpointResponse' (Maybe DeleteVpcEndpointDetail) Int |
Instances
newDeleteVpcEndpointResponse Source #
Create a value of DeleteVpcEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteVpcEndpointDetail:DeleteVpcEndpointResponse', deleteVpcEndpointResponse_deleteVpcEndpointDetail - Details about the deleted endpoint.
$sel:httpStatus:DeleteVpcEndpointResponse', deleteVpcEndpointResponse_httpStatus - The response's http status code.
GetAccessPolicy
data GetAccessPolicy Source #
See: newGetAccessPolicy smart constructor.
Constructors
| GetAccessPolicy' Text AccessPolicyType |
Instances
Arguments
| :: Text | |
| -> AccessPolicyType | |
| -> GetAccessPolicy |
Create a value of GetAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAccessPolicy, getAccessPolicy_name - The name of the access policy.
GetAccessPolicy, getAccessPolicy_type - Tye type of policy. Currently the only supported value is data.
data GetAccessPolicyResponse Source #
See: newGetAccessPolicyResponse smart constructor.
Constructors
| GetAccessPolicyResponse' (Maybe AccessPolicyDetail) Int |
Instances
newGetAccessPolicyResponse Source #
Create a value of GetAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPolicyDetail:GetAccessPolicyResponse', getAccessPolicyResponse_accessPolicyDetail - Details about the requested access policy.
$sel:httpStatus:GetAccessPolicyResponse', getAccessPolicyResponse_httpStatus - The response's http status code.
GetAccountSettings
data GetAccountSettings Source #
See: newGetAccountSettings smart constructor.
Constructors
| GetAccountSettings' | |
Instances
newGetAccountSettings :: GetAccountSettings Source #
Create a value of GetAccountSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetAccountSettingsResponse Source #
See: newGetAccountSettingsResponse smart constructor.
Constructors
| GetAccountSettingsResponse' (Maybe AccountSettingsDetail) Int |
Instances
newGetAccountSettingsResponse Source #
Create a value of GetAccountSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountSettingsDetail:GetAccountSettingsResponse', getAccountSettingsResponse_accountSettingsDetail - OpenSearch Serverless-related details for the current account.
$sel:httpStatus:GetAccountSettingsResponse', getAccountSettingsResponse_httpStatus - The response's http status code.
GetPoliciesStats
data GetPoliciesStats Source #
See: newGetPoliciesStats smart constructor.
Constructors
| GetPoliciesStats' | |
Instances
newGetPoliciesStats :: GetPoliciesStats Source #
Create a value of GetPoliciesStats with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetPoliciesStatsResponse Source #
See: newGetPoliciesStatsResponse smart constructor.
Constructors
| GetPoliciesStatsResponse' (Maybe AccessPolicyStats) (Maybe SecurityConfigStats) (Maybe SecurityPolicyStats) (Maybe Integer) Int |
Instances
newGetPoliciesStatsResponse Source #
Create a value of GetPoliciesStatsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPolicyStats:GetPoliciesStatsResponse', getPoliciesStatsResponse_accessPolicyStats - Information about the data access policies in your account.
$sel:securityConfigStats:GetPoliciesStatsResponse', getPoliciesStatsResponse_securityConfigStats - Information about the security configurations in your account.
$sel:securityPolicyStats:GetPoliciesStatsResponse', getPoliciesStatsResponse_securityPolicyStats - Information about the security policies in your account.
$sel:totalPolicyCount:GetPoliciesStatsResponse', getPoliciesStatsResponse_totalPolicyCount - The total number of OpenSearch Serverless security policies and
configurations in your account.
$sel:httpStatus:GetPoliciesStatsResponse', getPoliciesStatsResponse_httpStatus - The response's http status code.
GetSecurityConfig
data GetSecurityConfig Source #
See: newGetSecurityConfig smart constructor.
Constructors
| GetSecurityConfig' Text |
Instances
Arguments
| :: Text | |
| -> GetSecurityConfig |
Create a value of GetSecurityConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSecurityConfig, getSecurityConfig_id - The unique identifier of the security configuration.
data GetSecurityConfigResponse Source #
See: newGetSecurityConfigResponse smart constructor.
Constructors
| GetSecurityConfigResponse' (Maybe SecurityConfigDetail) Int |
Instances
newGetSecurityConfigResponse Source #
Create a value of GetSecurityConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityConfigDetail:GetSecurityConfigResponse', getSecurityConfigResponse_securityConfigDetail - Details of the requested security configuration.
$sel:httpStatus:GetSecurityConfigResponse', getSecurityConfigResponse_httpStatus - The response's http status code.
GetSecurityPolicy
data GetSecurityPolicy Source #
See: newGetSecurityPolicy smart constructor.
Constructors
| GetSecurityPolicy' Text SecurityPolicyType |
Instances
Create a value of GetSecurityPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSecurityPolicy, getSecurityPolicy_name - The name of the security policy.
GetSecurityPolicy, getSecurityPolicy_type - The type of security policy.
data GetSecurityPolicyResponse Source #
See: newGetSecurityPolicyResponse smart constructor.
Constructors
| GetSecurityPolicyResponse' (Maybe SecurityPolicyDetail) Int |
Instances
newGetSecurityPolicyResponse Source #
Create a value of GetSecurityPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityPolicyDetail:GetSecurityPolicyResponse', getSecurityPolicyResponse_securityPolicyDetail - Details about the requested security policy.
$sel:httpStatus:GetSecurityPolicyResponse', getSecurityPolicyResponse_httpStatus - The response's http status code.
ListAccessPolicies
data ListAccessPolicies Source #
See: newListAccessPolicies smart constructor.
Constructors
| ListAccessPolicies' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) AccessPolicyType |
Instances
newListAccessPolicies Source #
Arguments
| :: AccessPolicyType | |
| -> ListAccessPolicies |
Create a value of ListAccessPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAccessPolicies', listAccessPolicies_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.
ListAccessPolicies, listAccessPolicies_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.
$sel:resource:ListAccessPolicies', listAccessPolicies_resource - Resource filters (can be collection or indexes) that policies can apply
to.
ListAccessPolicies, listAccessPolicies_type - The type of access policy.
data ListAccessPoliciesResponse Source #
See: newListAccessPoliciesResponse smart constructor.
Constructors
| ListAccessPoliciesResponse' (Maybe [AccessPolicySummary]) (Maybe Text) Int |
Instances
newListAccessPoliciesResponse Source #
Create a value of ListAccessPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPolicySummaries:ListAccessPoliciesResponse', listAccessPoliciesResponse_accessPolicySummaries - Details about the requested access policies.
ListAccessPolicies, listAccessPoliciesResponse_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.
$sel:httpStatus:ListAccessPoliciesResponse', listAccessPoliciesResponse_httpStatus - The response's http status code.
ListCollections
data ListCollections Source #
See: newListCollections smart constructor.
Constructors
| ListCollections' (Maybe CollectionFilters) (Maybe Natural) (Maybe Text) |
Instances
newListCollections :: ListCollections Source #
Create a value of ListCollections with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionFilters:ListCollections', listCollections_collectionFilters - List of filter names and values that you can use for requests.
$sel:maxResults:ListCollections', listCollections_maxResults - The maximum number of results to return. Default is 20. You can use
nextToken to get the next page of results.
ListCollections, listCollections_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.
data ListCollectionsResponse Source #
See: newListCollectionsResponse smart constructor.
Constructors
| ListCollectionsResponse' (Maybe [CollectionSummary]) (Maybe Text) Int |
Instances
newListCollectionsResponse Source #
Create a value of ListCollectionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:collectionSummaries:ListCollectionsResponse', listCollectionsResponse_collectionSummaries - Details about each collection.
ListCollections, listCollectionsResponse_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.
$sel:httpStatus:ListCollectionsResponse', listCollectionsResponse_httpStatus - The response's http status code.
ListSecurityConfigs
data ListSecurityConfigs Source #
See: newListSecurityConfigs smart constructor.
Constructors
| ListSecurityConfigs' (Maybe Natural) (Maybe Text) SecurityConfigType |
Instances
newListSecurityConfigs Source #
Arguments
| :: SecurityConfigType | |
| -> ListSecurityConfigs |
Create a value of ListSecurityConfigs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSecurityConfigs', listSecurityConfigs_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.
ListSecurityConfigs, listSecurityConfigs_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.
ListSecurityConfigs, listSecurityConfigs_type - The type of security configuration.
data ListSecurityConfigsResponse Source #
See: newListSecurityConfigsResponse smart constructor.
Constructors
| ListSecurityConfigsResponse' (Maybe Text) (Maybe [SecurityConfigSummary]) Int |
Instances
newListSecurityConfigsResponse Source #
Create a value of ListSecurityConfigsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSecurityConfigs, listSecurityConfigsResponse_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.
$sel:securityConfigSummaries:ListSecurityConfigsResponse', listSecurityConfigsResponse_securityConfigSummaries - Details about the security configurations in your account.
$sel:httpStatus:ListSecurityConfigsResponse', listSecurityConfigsResponse_httpStatus - The response's http status code.
ListSecurityPolicies
data ListSecurityPolicies Source #
See: newListSecurityPolicies smart constructor.
Constructors
| ListSecurityPolicies' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) SecurityPolicyType |
Instances
newListSecurityPolicies Source #
Arguments
| :: SecurityPolicyType | |
| -> ListSecurityPolicies |
Create a value of ListSecurityPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSecurityPolicies', listSecurityPolicies_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.
ListSecurityPolicies, listSecurityPolicies_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.
$sel:resource:ListSecurityPolicies', listSecurityPolicies_resource - Resource filters (can be collection or indexes) that policies can apply
to.
ListSecurityPolicies, listSecurityPolicies_type - The type of policy.
data ListSecurityPoliciesResponse Source #
See: newListSecurityPoliciesResponse smart constructor.
Constructors
| ListSecurityPoliciesResponse' (Maybe Text) (Maybe [SecurityPolicySummary]) Int |
Instances
newListSecurityPoliciesResponse Source #
Create a value of ListSecurityPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSecurityPolicies, listSecurityPoliciesResponse_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.
$sel:securityPolicySummaries:ListSecurityPoliciesResponse', listSecurityPoliciesResponse_securityPolicySummaries - Details about the security policies in your account.
$sel:httpStatus:ListSecurityPoliciesResponse', listSecurityPoliciesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_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.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags associated with the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListVpcEndpoints
data ListVpcEndpoints Source #
See: newListVpcEndpoints smart constructor.
Constructors
| ListVpcEndpoints' (Maybe Natural) (Maybe Text) (Maybe VpcEndpointFilters) |
Instances
newListVpcEndpoints :: ListVpcEndpoints Source #
Create a value of ListVpcEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListVpcEndpoints', listVpcEndpoints_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.
ListVpcEndpoints, listVpcEndpoints_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.
$sel:vpcEndpointFilters:ListVpcEndpoints', listVpcEndpoints_vpcEndpointFilters - Filter the results according to the current status of the VPC endpoint.
Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and
FAILED.
data ListVpcEndpointsResponse Source #
See: newListVpcEndpointsResponse smart constructor.
Constructors
| ListVpcEndpointsResponse' (Maybe Text) (Maybe [VpcEndpointSummary]) Int |
Instances
newListVpcEndpointsResponse Source #
Create a value of ListVpcEndpointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListVpcEndpoints, listVpcEndpointsResponse_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.
$sel:vpcEndpointSummaries:ListVpcEndpointsResponse', listVpcEndpointsResponse_vpcEndpointSummaries - Details about each VPC endpoint, including the name and current status.
$sel:httpStatus:ListVpcEndpointsResponse', listVpcEndpointsResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_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.
$sel:tags:TagResource', tagResource_tags - A list of tags (key-value pairs) to add to the resource. All tag keys in
the request must be unique.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_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.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag or set of tags to remove from the resource. All tag keys in the
request must be unique.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateAccessPolicy
data UpdateAccessPolicy Source #
See: newUpdateAccessPolicy smart constructor.
Constructors
| UpdateAccessPolicy' (Maybe Text) (Maybe Text) (Maybe Text) Text Text AccessPolicyType |
Instances
newUpdateAccessPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> AccessPolicyType | |
| -> UpdateAccessPolicy |
Create a value of UpdateAccessPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateAccessPolicy', updateAccessPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
UpdateAccessPolicy, updateAccessPolicy_description - A description of the policy. Typically used to store information about
the permissions defined in the policy.
UpdateAccessPolicy, updateAccessPolicy_policy - The JSON policy document to use as the content for the policy.
UpdateAccessPolicy, updateAccessPolicy_name - The name of the policy.
UpdateAccessPolicy, updateAccessPolicy_policyVersion - The version of the policy being updated.
UpdateAccessPolicy, updateAccessPolicy_type - The type of policy.
data UpdateAccessPolicyResponse Source #
See: newUpdateAccessPolicyResponse smart constructor.
Constructors
| UpdateAccessPolicyResponse' (Maybe AccessPolicyDetail) Int |
Instances
newUpdateAccessPolicyResponse Source #
Create a value of UpdateAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPolicyDetail:UpdateAccessPolicyResponse', updateAccessPolicyResponse_accessPolicyDetail - Details about the updated access policy.
$sel:httpStatus:UpdateAccessPolicyResponse', updateAccessPolicyResponse_httpStatus - The response's http status code.
UpdateAccountSettings
data UpdateAccountSettings Source #
See: newUpdateAccountSettings smart constructor.
Constructors
| UpdateAccountSettings' (Maybe CapacityLimits) |
Instances
newUpdateAccountSettings :: UpdateAccountSettings Source #
Create a value of UpdateAccountSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAccountSettings, updateAccountSettings_capacityLimits - Undocumented member.
data UpdateAccountSettingsResponse Source #
See: newUpdateAccountSettingsResponse smart constructor.
Constructors
| UpdateAccountSettingsResponse' (Maybe AccountSettingsDetail) Int |
Instances
newUpdateAccountSettingsResponse Source #
Create a value of UpdateAccountSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountSettingsDetail:UpdateAccountSettingsResponse', updateAccountSettingsResponse_accountSettingsDetail - OpenSearch Serverless-related settings for the current Amazon Web
Services account.
$sel:httpStatus:UpdateAccountSettingsResponse', updateAccountSettingsResponse_httpStatus - The response's http status code.
UpdateCollection
data UpdateCollection Source #
See: newUpdateCollection smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateCollection |
Create a value of UpdateCollection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateCollection', updateCollection_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
UpdateCollection, updateCollection_description - A description of the collection.
UpdateCollection, updateCollection_id - The unique identifier of the collection.
data UpdateCollectionResponse Source #
See: newUpdateCollectionResponse smart constructor.
Constructors
| UpdateCollectionResponse' (Maybe UpdateCollectionDetail) Int |
Instances
newUpdateCollectionResponse Source #
Create a value of UpdateCollectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:updateCollectionDetail:UpdateCollectionResponse', updateCollectionResponse_updateCollectionDetail - Details about the updated collection.
$sel:httpStatus:UpdateCollectionResponse', updateCollectionResponse_httpStatus - The response's http status code.
UpdateSecurityConfig
data UpdateSecurityConfig Source #
See: newUpdateSecurityConfig smart constructor.
Constructors
| UpdateSecurityConfig' (Maybe Text) (Maybe Text) (Maybe SamlConfigOptions) Text Text |
Instances
newUpdateSecurityConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSecurityConfig |
Create a value of UpdateSecurityConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateSecurityConfig', updateSecurityConfig_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
UpdateSecurityConfig, updateSecurityConfig_description - A description of the security configuration.
UpdateSecurityConfig, updateSecurityConfig_samlOptions - SAML options in in the form of a key-value map.
UpdateSecurityConfig, updateSecurityConfig_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.
UpdateSecurityConfig, updateSecurityConfig_id - The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example,
saml/123456789123/OKTADev.
data UpdateSecurityConfigResponse Source #
See: newUpdateSecurityConfigResponse smart constructor.
Constructors
| UpdateSecurityConfigResponse' (Maybe SecurityConfigDetail) Int |
Instances
newUpdateSecurityConfigResponse Source #
Create a value of UpdateSecurityConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityConfigDetail:UpdateSecurityConfigResponse', updateSecurityConfigResponse_securityConfigDetail - Details about the updated security configuration.
$sel:httpStatus:UpdateSecurityConfigResponse', updateSecurityConfigResponse_httpStatus - The response's http status code.
UpdateSecurityPolicy
data UpdateSecurityPolicy Source #
See: newUpdateSecurityPolicy smart constructor.
Constructors
| UpdateSecurityPolicy' (Maybe Text) (Maybe Text) (Maybe Text) Text Text SecurityPolicyType |
Instances
newUpdateSecurityPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> SecurityPolicyType | |
| -> UpdateSecurityPolicy |
Create a value of UpdateSecurityPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateSecurityPolicy', updateSecurityPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
UpdateSecurityPolicy, updateSecurityPolicy_description - A description of the policy. Typically used to store information about
the permissions defined in the policy.
UpdateSecurityPolicy, updateSecurityPolicy_policy - The JSON policy document to use as the content for the new policy.
UpdateSecurityPolicy, updateSecurityPolicy_name - The name of the policy.
UpdateSecurityPolicy, updateSecurityPolicy_policyVersion - The version of the policy being updated.
UpdateSecurityPolicy, updateSecurityPolicy_type - The type of access policy.
data UpdateSecurityPolicyResponse Source #
See: newUpdateSecurityPolicyResponse smart constructor.
Constructors
| UpdateSecurityPolicyResponse' (Maybe SecurityPolicyDetail) Int |
Instances
newUpdateSecurityPolicyResponse Source #
Create a value of UpdateSecurityPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityPolicyDetail:UpdateSecurityPolicyResponse', updateSecurityPolicyResponse_securityPolicyDetail - Details about the updated security policy.
$sel:httpStatus:UpdateSecurityPolicyResponse', updateSecurityPolicyResponse_httpStatus - The response's http status code.
UpdateVpcEndpoint
data UpdateVpcEndpoint Source #
See: newUpdateVpcEndpoint smart constructor.
Constructors
| UpdateVpcEndpoint' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text |
Instances
Arguments
| :: Text | |
| -> UpdateVpcEndpoint |
Create a value of UpdateVpcEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addSecurityGroupIds:UpdateVpcEndpoint', updateVpcEndpoint_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.
$sel:addSubnetIds:UpdateVpcEndpoint', updateVpcEndpoint_addSubnetIds - The ID of one or more subnets to add to the endpoint.
$sel:clientToken:UpdateVpcEndpoint', updateVpcEndpoint_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
$sel:removeSecurityGroupIds:UpdateVpcEndpoint', updateVpcEndpoint_removeSecurityGroupIds - The unique identifiers of the security groups to remove from the
endpoint.
$sel:removeSubnetIds:UpdateVpcEndpoint', updateVpcEndpoint_removeSubnetIds - The unique identifiers of the subnets to remove from the endpoint.
UpdateVpcEndpoint, updateVpcEndpoint_id - The unique identifier of the interface endpoint to update.
data UpdateVpcEndpointResponse Source #
See: newUpdateVpcEndpointResponse smart constructor.
Constructors
| UpdateVpcEndpointResponse' (Maybe UpdateVpcEndpointDetail) Int |
Instances
newUpdateVpcEndpointResponse Source #
Create a value of UpdateVpcEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:updateVpcEndpointDetail:UpdateVpcEndpointResponse', updateVpcEndpointResponse_updateVpcEndpointDetail - Details about the updated VPC endpoint.
$sel:httpStatus:UpdateVpcEndpointResponse', updateVpcEndpointResponse_httpStatus - The response's http status code.
Types
AccessPolicyType
newtype AccessPolicyType Source #
Constructors
| AccessPolicyType' | |
Fields | |
Bundled Patterns
| pattern AccessPolicyType_Data :: AccessPolicyType |
Instances
CollectionStatus
newtype CollectionStatus Source #
Constructors
| CollectionStatus' | |
Fields | |
Bundled Patterns
| pattern CollectionStatus_ACTIVE :: CollectionStatus | |
| pattern CollectionStatus_CREATING :: CollectionStatus | |
| pattern CollectionStatus_DELETING :: CollectionStatus | |
| pattern CollectionStatus_FAILED :: CollectionStatus |
Instances
CollectionType
newtype CollectionType Source #
Constructors
| CollectionType' | |
Fields | |
Bundled Patterns
| pattern CollectionType_SEARCH :: CollectionType | |
| pattern CollectionType_TIMESERIES :: CollectionType |
Instances
SecurityConfigType
newtype SecurityConfigType Source #
Constructors
| SecurityConfigType' | |
Fields | |
Bundled Patterns
| pattern SecurityConfigType_Saml :: SecurityConfigType |
Instances
SecurityPolicyType
newtype SecurityPolicyType Source #
Constructors
| SecurityPolicyType' | |
Fields | |
Bundled Patterns
| pattern SecurityPolicyType_Encryption :: SecurityPolicyType | |
| pattern SecurityPolicyType_Network :: SecurityPolicyType |
Instances
VpcEndpointStatus
newtype VpcEndpointStatus Source #
Constructors
| VpcEndpointStatus' | |
Fields | |
Bundled Patterns
| pattern VpcEndpointStatus_ACTIVE :: VpcEndpointStatus | |
| pattern VpcEndpointStatus_DELETING :: VpcEndpointStatus | |
| pattern VpcEndpointStatus_FAILED :: VpcEndpointStatus | |
| pattern VpcEndpointStatus_PENDING :: VpcEndpointStatus |
Instances
AccessPolicyDetail
data AccessPolicyDetail Source #
Details about an OpenSearch Serverless access policy.
See: newAccessPolicyDetail smart constructor.
Constructors
| AccessPolicyDetail' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Document) (Maybe Text) (Maybe AccessPolicyType) |
Instances
newAccessPolicyDetail :: AccessPolicyDetail Source #
Create a value of AccessPolicyDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:AccessPolicyDetail', accessPolicyDetail_createdDate - The date the policy was created.
$sel:description:AccessPolicyDetail', accessPolicyDetail_description - The description of the policy.
$sel:lastModifiedDate:AccessPolicyDetail', accessPolicyDetail_lastModifiedDate - The timestamp of when the policy was last modified.
$sel:name:AccessPolicyDetail', accessPolicyDetail_name - The name of the policy.
$sel:policy:AccessPolicyDetail', accessPolicyDetail_policy - The JSON policy document without any whitespaces.
$sel:policyVersion:AccessPolicyDetail', accessPolicyDetail_policyVersion - The version of the policy.
$sel:type':AccessPolicyDetail', accessPolicyDetail_type - The type of access policy.
AccessPolicyStats
data AccessPolicyStats Source #
Statistics for an OpenSearch Serverless access policy.
See: newAccessPolicyStats smart constructor.
Constructors
| AccessPolicyStats' (Maybe Integer) |
Instances
newAccessPolicyStats :: AccessPolicyStats Source #
Create a value of AccessPolicyStats with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataPolicyCount:AccessPolicyStats', accessPolicyStats_dataPolicyCount - The number of data access policies in the current account.
AccessPolicySummary
data AccessPolicySummary Source #
A summary of the data access policy.
See: newAccessPolicySummary smart constructor.
Constructors
| AccessPolicySummary' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe AccessPolicyType) |
Instances
newAccessPolicySummary :: AccessPolicySummary Source #
Create a value of AccessPolicySummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:AccessPolicySummary', accessPolicySummary_createdDate - The Epoch time when the access policy was created.
$sel:description:AccessPolicySummary', accessPolicySummary_description - The description of the access policy.
$sel:lastModifiedDate:AccessPolicySummary', accessPolicySummary_lastModifiedDate - The date and time when the collection was last modified.
$sel:name:AccessPolicySummary', accessPolicySummary_name - The name of the access policy.
$sel:policyVersion:AccessPolicySummary', accessPolicySummary_policyVersion - The version of the policy.
$sel:type':AccessPolicySummary', accessPolicySummary_type - The type of access policy. Currently the only available type is data.
AccountSettingsDetail
data AccountSettingsDetail Source #
OpenSearch Serverless-related information for the current account.
See: newAccountSettingsDetail smart constructor.
Constructors
| AccountSettingsDetail' (Maybe CapacityLimits) |
Instances
newAccountSettingsDetail :: AccountSettingsDetail Source #
Create a value of AccountSettingsDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityLimits:AccountSettingsDetail', accountSettingsDetail_capacityLimits - Undocumented member.
CapacityLimits
data CapacityLimits Source #
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 Autoscaling.
See: newCapacityLimits smart constructor.
Constructors
| CapacityLimits' (Maybe Natural) (Maybe Natural) |
Instances
newCapacityLimits :: CapacityLimits Source #
Create a value of CapacityLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxIndexingCapacityInOCU:CapacityLimits', capacityLimits_maxIndexingCapacityInOCU - The maximum indexing capacity for collections.
$sel:maxSearchCapacityInOCU:CapacityLimits', capacityLimits_maxSearchCapacityInOCU - The maximum search capacity for collections.
CollectionDetail
data CollectionDetail Source #
Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.
See: newCollectionDetail smart constructor.
Constructors
| CollectionDetail' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe CollectionStatus) (Maybe CollectionType) |
Instances
newCollectionDetail :: CollectionDetail Source #
Create a value of CollectionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:CollectionDetail', collectionDetail_arn - The Amazon Resource Name (ARN) of the collection.
$sel:collectionEndpoint:CollectionDetail', collectionDetail_collectionEndpoint - Collection-specific endpoint used to submit index, search, and data
upload requests to an OpenSearch Serverless collection.
$sel:createdDate:CollectionDetail', collectionDetail_createdDate - The Epoch time when the collection was created.
$sel:dashboardEndpoint:CollectionDetail', collectionDetail_dashboardEndpoint - Collection-specific endpoint used to access OpenSearch Dashboards.
$sel:description:CollectionDetail', collectionDetail_description - A description of the collection.
$sel:id:CollectionDetail', collectionDetail_id - A unique identifier for the collection.
$sel:kmsKeyArn:CollectionDetail', collectionDetail_kmsKeyArn - The ARN of the Amazon Web Services KMS key used to encrypt the
collection.
$sel:lastModifiedDate:CollectionDetail', collectionDetail_lastModifiedDate - The date and time when the collection was last modified.
$sel:name:CollectionDetail', collectionDetail_name - The name of the collection.
$sel:status:CollectionDetail', collectionDetail_status - The current status of the collection.
$sel:type':CollectionDetail', collectionDetail_type - The type of collection.
CollectionErrorDetail
data CollectionErrorDetail Source #
Error information for an OpenSearch Serverless request.
See: newCollectionErrorDetail smart constructor.
Instances
newCollectionErrorDetail :: CollectionErrorDetail Source #
Create a value of CollectionErrorDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:CollectionErrorDetail', collectionErrorDetail_errorCode - The error code for the request. For example, NOT_FOUND.
$sel:errorMessage:CollectionErrorDetail', collectionErrorDetail_errorMessage - A description of the error. For example,
The specified Collection is not found.
$sel:id:CollectionErrorDetail', collectionErrorDetail_id - If the request contains collection IDs, the response includes the IDs
provided in the request.
$sel:name:CollectionErrorDetail', collectionErrorDetail_name - If the request contains collection names, the response includes the
names provided in the request.
CollectionFilters
data CollectionFilters Source #
List of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.
See: newCollectionFilters smart constructor.
Constructors
| CollectionFilters' (Maybe Text) (Maybe CollectionStatus) |
Instances
newCollectionFilters :: CollectionFilters Source #
Create a value of CollectionFilters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:CollectionFilters', collectionFilters_name - The name of the collection.
$sel:status:CollectionFilters', collectionFilters_status - The current status of the collection.
CollectionSummary
data CollectionSummary Source #
Details about each OpenSearch Serverless collection.
See: newCollectionSummary smart constructor.
Constructors
| CollectionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CollectionStatus) |
Instances
newCollectionSummary :: CollectionSummary Source #
Create a value of CollectionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:CollectionSummary', collectionSummary_arn - The Amazon Resource Name (ARN) of the collection.
$sel:id:CollectionSummary', collectionSummary_id - The unique identifier of the collection.
$sel:name:CollectionSummary', collectionSummary_name - The name of the collection.
$sel:status:CollectionSummary', collectionSummary_status - The current status of the collection.
CreateCollectionDetail
data CreateCollectionDetail Source #
Details about the created OpenSearch Serverless collection.
See: newCreateCollectionDetail smart constructor.
Constructors
| CreateCollectionDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe CollectionStatus) (Maybe CollectionType) |
Instances
newCreateCollectionDetail :: CreateCollectionDetail Source #
Create a value of CreateCollectionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:CreateCollectionDetail', createCollectionDetail_arn - The Amazon Resource Name (ARN) of the collection.
$sel:createdDate:CreateCollectionDetail', createCollectionDetail_createdDate - The Epoch time when the collection was created.
$sel:description:CreateCollectionDetail', createCollectionDetail_description - A description of the collection.
$sel:id:CreateCollectionDetail', createCollectionDetail_id - The unique identifier of the collection.
$sel:kmsKeyArn:CreateCollectionDetail', createCollectionDetail_kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key with which to encrypt the
collection.
$sel:lastModifiedDate:CreateCollectionDetail', createCollectionDetail_lastModifiedDate - The date and time when the collection was last modified.
$sel:name:CreateCollectionDetail', createCollectionDetail_name - The name of the collection.
$sel:status:CreateCollectionDetail', createCollectionDetail_status - The current status of the collection.
$sel:type':CreateCollectionDetail', createCollectionDetail_type - The type of collection.
CreateVpcEndpointDetail
data CreateVpcEndpointDetail Source #
Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
See: newCreateVpcEndpointDetail smart constructor.
Constructors
| CreateVpcEndpointDetail' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus) |
Instances
newCreateVpcEndpointDetail :: CreateVpcEndpointDetail Source #
Create a value of CreateVpcEndpointDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:CreateVpcEndpointDetail', createVpcEndpointDetail_id - The unique identifier of the endpoint.
$sel:name:CreateVpcEndpointDetail', createVpcEndpointDetail_name - The name of the endpoint.
$sel:status:CreateVpcEndpointDetail', createVpcEndpointDetail_status - The current status in the endpoint creation process.
DeleteCollectionDetail
data DeleteCollectionDetail Source #
Details about a deleted OpenSearch Serverless collection.
See: newDeleteCollectionDetail smart constructor.
Constructors
| DeleteCollectionDetail' (Maybe Text) (Maybe Text) (Maybe CollectionStatus) |
Instances
newDeleteCollectionDetail :: DeleteCollectionDetail Source #
Create a value of DeleteCollectionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DeleteCollectionDetail', deleteCollectionDetail_id - The unique identifier of the collection.
$sel:name:DeleteCollectionDetail', deleteCollectionDetail_name - The name of the collection.
$sel:status:DeleteCollectionDetail', deleteCollectionDetail_status - The current status of the collection.
DeleteVpcEndpointDetail
data DeleteVpcEndpointDetail Source #
Deletion details for an OpenSearch Serverless-managed interface endpoint.
See: newDeleteVpcEndpointDetail smart constructor.
Constructors
| DeleteVpcEndpointDetail' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus) |
Instances
newDeleteVpcEndpointDetail :: DeleteVpcEndpointDetail Source #
Create a value of DeleteVpcEndpointDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DeleteVpcEndpointDetail', deleteVpcEndpointDetail_id - The unique identifier of the endpoint.
$sel:name:DeleteVpcEndpointDetail', deleteVpcEndpointDetail_name - The name of the endpoint.
$sel:status:DeleteVpcEndpointDetail', deleteVpcEndpointDetail_status - The current status of the endpoint deletion process.
Document
See: newDocument smart constructor.
Constructors
| Document' | |
Instances
newDocument :: Document Source #
Create a value of Document with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SamlConfigOptions
data SamlConfigOptions Source #
Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
See: newSamlConfigOptions smart constructor.
Instances
Arguments
| :: Text | |
| -> SamlConfigOptions |
Create a value of SamlConfigOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupAttribute:SamlConfigOptions', samlConfigOptions_groupAttribute - The group attribute for this SAML integration.
$sel:sessionTimeout:SamlConfigOptions', samlConfigOptions_sessionTimeout - The session timeout, in minutes. Minimum is 15 minutes and maximum is
1440 minutes (24 hours or 1 day). Default is 60 minutes.
$sel:userAttribute:SamlConfigOptions', samlConfigOptions_userAttribute - A user attribute for this SAML integration.
$sel:metadata:SamlConfigOptions', samlConfigOptions_metadata - The XML IdP metadata file generated from your identity provider.
SecurityConfigDetail
data SecurityConfigDetail Source #
Details about a security configuration for OpenSearch Serverless.
See: newSecurityConfigDetail smart constructor.
Constructors
| SecurityConfigDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe SamlConfigOptions) (Maybe SecurityConfigType) |
Instances
newSecurityConfigDetail :: SecurityConfigDetail Source #
Create a value of SecurityConfigDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configVersion:SecurityConfigDetail', securityConfigDetail_configVersion - The version of the security configuration.
$sel:createdDate:SecurityConfigDetail', securityConfigDetail_createdDate - The date the configuration was created.
$sel:description:SecurityConfigDetail', securityConfigDetail_description - The description of the security configuration.
$sel:id:SecurityConfigDetail', securityConfigDetail_id - The unique identifier of the security configuration.
$sel:lastModifiedDate:SecurityConfigDetail', securityConfigDetail_lastModifiedDate - The timestamp of when the configuration was last modified.
$sel:samlOptions:SecurityConfigDetail', securityConfigDetail_samlOptions - SAML options for the security configuration in the form of a key-value
map.
$sel:type':SecurityConfigDetail', securityConfigDetail_type - The type of security configuration.
SecurityConfigStats
data SecurityConfigStats Source #
Statistics for an OpenSearch Serverless security configuration.
See: newSecurityConfigStats smart constructor.
Constructors
| SecurityConfigStats' (Maybe Integer) |
Instances
newSecurityConfigStats :: SecurityConfigStats Source #
Create a value of SecurityConfigStats with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samlConfigCount:SecurityConfigStats', securityConfigStats_samlConfigCount - The number of security configurations in the current account.
SecurityConfigSummary
data SecurityConfigSummary Source #
A summary of a security configuration for OpenSearch Serverless.
See: newSecurityConfigSummary smart constructor.
Constructors
| SecurityConfigSummary' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe SecurityConfigType) |
Instances
newSecurityConfigSummary :: SecurityConfigSummary Source #
Create a value of SecurityConfigSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configVersion:SecurityConfigSummary', securityConfigSummary_configVersion - The version of the security configuration.
$sel:createdDate:SecurityConfigSummary', securityConfigSummary_createdDate - The Epoch time when the security configuration was created.
$sel:description:SecurityConfigSummary', securityConfigSummary_description - The description of the security configuration.
$sel:id:SecurityConfigSummary', securityConfigSummary_id - The unique identifier of the security configuration.
$sel:lastModifiedDate:SecurityConfigSummary', securityConfigSummary_lastModifiedDate - The timestamp of when the configuration was last modified.
$sel:type':SecurityConfigSummary', securityConfigSummary_type - The type of security configuration.
SecurityPolicyDetail
data SecurityPolicyDetail Source #
Details about an OpenSearch Serverless security policy.
See: newSecurityPolicyDetail smart constructor.
Constructors
| SecurityPolicyDetail' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Document) (Maybe Text) (Maybe SecurityPolicyType) |
Instances
newSecurityPolicyDetail :: SecurityPolicyDetail Source #
Create a value of SecurityPolicyDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:SecurityPolicyDetail', securityPolicyDetail_createdDate - The date the policy was created.
$sel:description:SecurityPolicyDetail', securityPolicyDetail_description - The description of the security policy.
$sel:lastModifiedDate:SecurityPolicyDetail', securityPolicyDetail_lastModifiedDate - The timestamp of when the policy was last modified.
$sel:name:SecurityPolicyDetail', securityPolicyDetail_name - The name of the policy.
$sel:policy:SecurityPolicyDetail', securityPolicyDetail_policy - The JSON policy document without any whitespaces.
$sel:policyVersion:SecurityPolicyDetail', securityPolicyDetail_policyVersion - The version of the policy.
$sel:type':SecurityPolicyDetail', securityPolicyDetail_type - The type of security policy.
SecurityPolicyStats
data SecurityPolicyStats Source #
Statistics for an OpenSearch Serverless security policy.
See: newSecurityPolicyStats smart constructor.
Constructors
| SecurityPolicyStats' (Maybe Integer) (Maybe Integer) |
Instances
newSecurityPolicyStats :: SecurityPolicyStats Source #
Create a value of SecurityPolicyStats with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionPolicyCount:SecurityPolicyStats', securityPolicyStats_encryptionPolicyCount - The number of encryption policies in the current account.
$sel:networkPolicyCount:SecurityPolicyStats', securityPolicyStats_networkPolicyCount - The number of network policies in the current account.
SecurityPolicySummary
data SecurityPolicySummary Source #
A summary of a security policy for OpenSearch Serverless.
See: newSecurityPolicySummary smart constructor.
Constructors
| SecurityPolicySummary' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe SecurityPolicyType) |
Instances
newSecurityPolicySummary :: SecurityPolicySummary Source #
Create a value of SecurityPolicySummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:SecurityPolicySummary', securityPolicySummary_createdDate - The date the policy was created.
$sel:description:SecurityPolicySummary', securityPolicySummary_description - The description of the security policy.
$sel:lastModifiedDate:SecurityPolicySummary', securityPolicySummary_lastModifiedDate - The timestamp of when the policy was last modified.
$sel:name:SecurityPolicySummary', securityPolicySummary_name - The name of the policy.
$sel:policyVersion:SecurityPolicySummary', securityPolicySummary_policyVersion - The version of the policy.
$sel:type':SecurityPolicySummary', securityPolicySummary_type - The type of security policy.
Tag
A map of key-value pairs associated to an OpenSearch Serverless resource.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.OpenSearchServerless.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.OpenSearchServerless.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.OpenSearchServerless.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.OpenSearchServerless.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.OpenSearchServerless.Types.Tag" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key to use in the tag.
$sel:value:Tag', tag_value - The value of the tag.
UpdateCollectionDetail
data UpdateCollectionDetail Source #
Details about an updated OpenSearch Serverless collection.
See: newUpdateCollectionDetail smart constructor.
Constructors
| UpdateCollectionDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe CollectionStatus) (Maybe CollectionType) |
Instances
newUpdateCollectionDetail :: UpdateCollectionDetail Source #
Create a value of UpdateCollectionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:UpdateCollectionDetail', updateCollectionDetail_arn - The Amazon Resource Name (ARN) of the collection.
$sel:createdDate:UpdateCollectionDetail', updateCollectionDetail_createdDate - The date and time when the collection was created.
$sel:description:UpdateCollectionDetail', updateCollectionDetail_description - The description of the collection.
$sel:id:UpdateCollectionDetail', updateCollectionDetail_id - The unique identifier of the collection.
$sel:lastModifiedDate:UpdateCollectionDetail', updateCollectionDetail_lastModifiedDate - The date and time when the collection was last modified.
$sel:name:UpdateCollectionDetail', updateCollectionDetail_name - The name of the collection.
$sel:status:UpdateCollectionDetail', updateCollectionDetail_status - The current status of the collection.
$sel:type':UpdateCollectionDetail', updateCollectionDetail_type - The collection type.
UpdateVpcEndpointDetail
data UpdateVpcEndpointDetail Source #
Update details for an OpenSearch Serverless-managed interface endpoint.
See: newUpdateVpcEndpointDetail smart constructor.
Constructors
| UpdateVpcEndpointDetail' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe VpcEndpointStatus) (Maybe (NonEmpty Text)) |
Instances
newUpdateVpcEndpointDetail :: UpdateVpcEndpointDetail Source #
Create a value of UpdateVpcEndpointDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UpdateVpcEndpointDetail', updateVpcEndpointDetail_id - The unique identifier of the endpoint.
$sel:lastModifiedDate:UpdateVpcEndpointDetail', updateVpcEndpointDetail_lastModifiedDate - The timestamp of when the endpoint was last modified.
$sel:name:UpdateVpcEndpointDetail', updateVpcEndpointDetail_name - The name of the endpoint.
$sel:securityGroupIds:UpdateVpcEndpointDetail', updateVpcEndpointDetail_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.
$sel:status:UpdateVpcEndpointDetail', updateVpcEndpointDetail_status - The current status of the endpoint update process.
$sel:subnetIds:UpdateVpcEndpointDetail', updateVpcEndpointDetail_subnetIds - The ID of the subnets from which you access OpenSearch Serverless.
VpcEndpointDetail
data VpcEndpointDetail Source #
Details about an OpenSearch Serverless-managed interface endpoint.
See: newVpcEndpointDetail smart constructor.
Constructors
| VpcEndpointDetail' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe VpcEndpointStatus) (Maybe (NonEmpty Text)) (Maybe Text) |
Instances
newVpcEndpointDetail :: VpcEndpointDetail Source #
Create a value of VpcEndpointDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:VpcEndpointDetail', vpcEndpointDetail_createdDate - The date the endpoint was created.
$sel:id:VpcEndpointDetail', vpcEndpointDetail_id - The unique identifier of the endpoint.
$sel:name:VpcEndpointDetail', vpcEndpointDetail_name - The name of the endpoint.
$sel:securityGroupIds:VpcEndpointDetail', vpcEndpointDetail_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.
$sel:status:VpcEndpointDetail', vpcEndpointDetail_status - The current status of the endpoint.
$sel:subnetIds:VpcEndpointDetail', vpcEndpointDetail_subnetIds - The ID of the subnets from which you access OpenSearch Serverless.
$sel:vpcId:VpcEndpointDetail', vpcEndpointDetail_vpcId - The ID of the VPC from which you access OpenSearch Serverless
VpcEndpointErrorDetail
data VpcEndpointErrorDetail Source #
Error information for a failed BatchGetVpcEndpoint request.
See: newVpcEndpointErrorDetail smart constructor.
Instances
newVpcEndpointErrorDetail :: VpcEndpointErrorDetail Source #
Create a value of VpcEndpointErrorDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:VpcEndpointErrorDetail', vpcEndpointErrorDetail_errorCode - The error code for the failed request.
$sel:errorMessage:VpcEndpointErrorDetail', vpcEndpointErrorDetail_errorMessage - An error message describing the reason for the failure.
$sel:id:VpcEndpointErrorDetail', vpcEndpointErrorDetail_id - The unique identifier of the VPC endpoint.
VpcEndpointFilters
data VpcEndpointFilters Source #
Filter the results of a ListVpcEndpoints request.
See: newVpcEndpointFilters smart constructor.
Constructors
| VpcEndpointFilters' (Maybe VpcEndpointStatus) |
Instances
newVpcEndpointFilters :: VpcEndpointFilters Source #
Create a value of VpcEndpointFilters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:VpcEndpointFilters', vpcEndpointFilters_status - The current status of the endpoint.
VpcEndpointSummary
data VpcEndpointSummary Source #
The VPC endpoint object.
See: newVpcEndpointSummary smart constructor.
Constructors
| VpcEndpointSummary' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus) |
Instances
newVpcEndpointSummary :: VpcEndpointSummary Source #
Create a value of VpcEndpointSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:VpcEndpointSummary', vpcEndpointSummary_id - The unique identifier of the endpoint.
$sel:name:VpcEndpointSummary', vpcEndpointSummary_name - The name of the endpoint.
$sel:status:VpcEndpointSummary', vpcEndpointSummary_status - The current status of the endpoint.