| 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.Types
Contents
- Service Configuration
- Errors
- 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
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
- 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' {}
- newAccessPolicyDetail :: AccessPolicyDetail
- accessPolicyDetail_createdDate :: Lens' AccessPolicyDetail (Maybe Integer)
- accessPolicyDetail_description :: Lens' AccessPolicyDetail (Maybe Text)
- accessPolicyDetail_lastModifiedDate :: Lens' AccessPolicyDetail (Maybe Integer)
- accessPolicyDetail_name :: Lens' AccessPolicyDetail (Maybe Text)
- accessPolicyDetail_policy :: Lens' AccessPolicyDetail (Maybe Document)
- accessPolicyDetail_policyVersion :: Lens' AccessPolicyDetail (Maybe Text)
- accessPolicyDetail_type :: Lens' AccessPolicyDetail (Maybe AccessPolicyType)
- data AccessPolicyStats = AccessPolicyStats' {}
- newAccessPolicyStats :: AccessPolicyStats
- accessPolicyStats_dataPolicyCount :: Lens' AccessPolicyStats (Maybe Integer)
- data AccessPolicySummary = AccessPolicySummary' {}
- newAccessPolicySummary :: AccessPolicySummary
- accessPolicySummary_createdDate :: Lens' AccessPolicySummary (Maybe Integer)
- accessPolicySummary_description :: Lens' AccessPolicySummary (Maybe Text)
- accessPolicySummary_lastModifiedDate :: Lens' AccessPolicySummary (Maybe Integer)
- accessPolicySummary_name :: Lens' AccessPolicySummary (Maybe Text)
- accessPolicySummary_policyVersion :: Lens' AccessPolicySummary (Maybe Text)
- accessPolicySummary_type :: Lens' AccessPolicySummary (Maybe AccessPolicyType)
- data AccountSettingsDetail = AccountSettingsDetail' {}
- newAccountSettingsDetail :: AccountSettingsDetail
- accountSettingsDetail_capacityLimits :: Lens' AccountSettingsDetail (Maybe CapacityLimits)
- data CapacityLimits = CapacityLimits' {}
- newCapacityLimits :: CapacityLimits
- capacityLimits_maxIndexingCapacityInOCU :: Lens' CapacityLimits (Maybe Natural)
- capacityLimits_maxSearchCapacityInOCU :: Lens' CapacityLimits (Maybe Natural)
- data CollectionDetail = CollectionDetail' {}
- newCollectionDetail :: CollectionDetail
- collectionDetail_arn :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_collectionEndpoint :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_createdDate :: Lens' CollectionDetail (Maybe Integer)
- collectionDetail_dashboardEndpoint :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_description :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_id :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_kmsKeyArn :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_lastModifiedDate :: Lens' CollectionDetail (Maybe Integer)
- collectionDetail_name :: Lens' CollectionDetail (Maybe Text)
- collectionDetail_status :: Lens' CollectionDetail (Maybe CollectionStatus)
- collectionDetail_type :: Lens' CollectionDetail (Maybe CollectionType)
- data CollectionErrorDetail = CollectionErrorDetail' {}
- newCollectionErrorDetail :: CollectionErrorDetail
- collectionErrorDetail_errorCode :: Lens' CollectionErrorDetail (Maybe Text)
- collectionErrorDetail_errorMessage :: Lens' CollectionErrorDetail (Maybe Text)
- collectionErrorDetail_id :: Lens' CollectionErrorDetail (Maybe Text)
- collectionErrorDetail_name :: Lens' CollectionErrorDetail (Maybe Text)
- data CollectionFilters = CollectionFilters' {}
- newCollectionFilters :: CollectionFilters
- collectionFilters_name :: Lens' CollectionFilters (Maybe Text)
- collectionFilters_status :: Lens' CollectionFilters (Maybe CollectionStatus)
- data CollectionSummary = CollectionSummary' {}
- newCollectionSummary :: CollectionSummary
- collectionSummary_arn :: Lens' CollectionSummary (Maybe Text)
- collectionSummary_id :: Lens' CollectionSummary (Maybe Text)
- collectionSummary_name :: Lens' CollectionSummary (Maybe Text)
- collectionSummary_status :: Lens' CollectionSummary (Maybe CollectionStatus)
- data CreateCollectionDetail = CreateCollectionDetail' {}
- newCreateCollectionDetail :: CreateCollectionDetail
- createCollectionDetail_arn :: Lens' CreateCollectionDetail (Maybe Text)
- createCollectionDetail_createdDate :: Lens' CreateCollectionDetail (Maybe Integer)
- createCollectionDetail_description :: Lens' CreateCollectionDetail (Maybe Text)
- createCollectionDetail_id :: Lens' CreateCollectionDetail (Maybe Text)
- createCollectionDetail_kmsKeyArn :: Lens' CreateCollectionDetail (Maybe Text)
- createCollectionDetail_lastModifiedDate :: Lens' CreateCollectionDetail (Maybe Integer)
- createCollectionDetail_name :: Lens' CreateCollectionDetail (Maybe Text)
- createCollectionDetail_status :: Lens' CreateCollectionDetail (Maybe CollectionStatus)
- createCollectionDetail_type :: Lens' CreateCollectionDetail (Maybe CollectionType)
- data CreateVpcEndpointDetail = CreateVpcEndpointDetail' {}
- newCreateVpcEndpointDetail :: CreateVpcEndpointDetail
- createVpcEndpointDetail_id :: Lens' CreateVpcEndpointDetail (Maybe Text)
- createVpcEndpointDetail_name :: Lens' CreateVpcEndpointDetail (Maybe Text)
- createVpcEndpointDetail_status :: Lens' CreateVpcEndpointDetail (Maybe VpcEndpointStatus)
- data DeleteCollectionDetail = DeleteCollectionDetail' {}
- newDeleteCollectionDetail :: DeleteCollectionDetail
- deleteCollectionDetail_id :: Lens' DeleteCollectionDetail (Maybe Text)
- deleteCollectionDetail_name :: Lens' DeleteCollectionDetail (Maybe Text)
- deleteCollectionDetail_status :: Lens' DeleteCollectionDetail (Maybe CollectionStatus)
- data DeleteVpcEndpointDetail = DeleteVpcEndpointDetail' {}
- newDeleteVpcEndpointDetail :: DeleteVpcEndpointDetail
- deleteVpcEndpointDetail_id :: Lens' DeleteVpcEndpointDetail (Maybe Text)
- deleteVpcEndpointDetail_name :: Lens' DeleteVpcEndpointDetail (Maybe Text)
- deleteVpcEndpointDetail_status :: Lens' DeleteVpcEndpointDetail (Maybe VpcEndpointStatus)
- data Document = Document' {
- newDocument :: Document
- data SamlConfigOptions = SamlConfigOptions' {}
- newSamlConfigOptions :: Text -> SamlConfigOptions
- samlConfigOptions_groupAttribute :: Lens' SamlConfigOptions (Maybe Text)
- samlConfigOptions_sessionTimeout :: Lens' SamlConfigOptions (Maybe Natural)
- samlConfigOptions_userAttribute :: Lens' SamlConfigOptions (Maybe Text)
- samlConfigOptions_metadata :: Lens' SamlConfigOptions Text
- data SecurityConfigDetail = SecurityConfigDetail' {}
- newSecurityConfigDetail :: SecurityConfigDetail
- securityConfigDetail_configVersion :: Lens' SecurityConfigDetail (Maybe Text)
- securityConfigDetail_createdDate :: Lens' SecurityConfigDetail (Maybe Integer)
- securityConfigDetail_description :: Lens' SecurityConfigDetail (Maybe Text)
- securityConfigDetail_id :: Lens' SecurityConfigDetail (Maybe Text)
- securityConfigDetail_lastModifiedDate :: Lens' SecurityConfigDetail (Maybe Integer)
- securityConfigDetail_samlOptions :: Lens' SecurityConfigDetail (Maybe SamlConfigOptions)
- securityConfigDetail_type :: Lens' SecurityConfigDetail (Maybe SecurityConfigType)
- data SecurityConfigStats = SecurityConfigStats' {}
- newSecurityConfigStats :: SecurityConfigStats
- securityConfigStats_samlConfigCount :: Lens' SecurityConfigStats (Maybe Integer)
- data SecurityConfigSummary = SecurityConfigSummary' {}
- newSecurityConfigSummary :: SecurityConfigSummary
- securityConfigSummary_configVersion :: Lens' SecurityConfigSummary (Maybe Text)
- securityConfigSummary_createdDate :: Lens' SecurityConfigSummary (Maybe Integer)
- securityConfigSummary_description :: Lens' SecurityConfigSummary (Maybe Text)
- securityConfigSummary_id :: Lens' SecurityConfigSummary (Maybe Text)
- securityConfigSummary_lastModifiedDate :: Lens' SecurityConfigSummary (Maybe Integer)
- securityConfigSummary_type :: Lens' SecurityConfigSummary (Maybe SecurityConfigType)
- data SecurityPolicyDetail = SecurityPolicyDetail' {}
- newSecurityPolicyDetail :: SecurityPolicyDetail
- securityPolicyDetail_createdDate :: Lens' SecurityPolicyDetail (Maybe Integer)
- securityPolicyDetail_description :: Lens' SecurityPolicyDetail (Maybe Text)
- securityPolicyDetail_lastModifiedDate :: Lens' SecurityPolicyDetail (Maybe Integer)
- securityPolicyDetail_name :: Lens' SecurityPolicyDetail (Maybe Text)
- securityPolicyDetail_policy :: Lens' SecurityPolicyDetail (Maybe Document)
- securityPolicyDetail_policyVersion :: Lens' SecurityPolicyDetail (Maybe Text)
- securityPolicyDetail_type :: Lens' SecurityPolicyDetail (Maybe SecurityPolicyType)
- data SecurityPolicyStats = SecurityPolicyStats' {}
- newSecurityPolicyStats :: SecurityPolicyStats
- securityPolicyStats_encryptionPolicyCount :: Lens' SecurityPolicyStats (Maybe Integer)
- securityPolicyStats_networkPolicyCount :: Lens' SecurityPolicyStats (Maybe Integer)
- data SecurityPolicySummary = SecurityPolicySummary' {}
- newSecurityPolicySummary :: SecurityPolicySummary
- securityPolicySummary_createdDate :: Lens' SecurityPolicySummary (Maybe Integer)
- securityPolicySummary_description :: Lens' SecurityPolicySummary (Maybe Text)
- securityPolicySummary_lastModifiedDate :: Lens' SecurityPolicySummary (Maybe Integer)
- securityPolicySummary_name :: Lens' SecurityPolicySummary (Maybe Text)
- securityPolicySummary_policyVersion :: Lens' SecurityPolicySummary (Maybe Text)
- securityPolicySummary_type :: Lens' SecurityPolicySummary (Maybe SecurityPolicyType)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data UpdateCollectionDetail = UpdateCollectionDetail' {
- arn :: Maybe Text
- createdDate :: Maybe Integer
- description :: Maybe Text
- id :: Maybe Text
- lastModifiedDate :: Maybe Integer
- name :: Maybe Text
- status :: Maybe CollectionStatus
- type' :: Maybe CollectionType
- newUpdateCollectionDetail :: UpdateCollectionDetail
- updateCollectionDetail_arn :: Lens' UpdateCollectionDetail (Maybe Text)
- updateCollectionDetail_createdDate :: Lens' UpdateCollectionDetail (Maybe Integer)
- updateCollectionDetail_description :: Lens' UpdateCollectionDetail (Maybe Text)
- updateCollectionDetail_id :: Lens' UpdateCollectionDetail (Maybe Text)
- updateCollectionDetail_lastModifiedDate :: Lens' UpdateCollectionDetail (Maybe Integer)
- updateCollectionDetail_name :: Lens' UpdateCollectionDetail (Maybe Text)
- updateCollectionDetail_status :: Lens' UpdateCollectionDetail (Maybe CollectionStatus)
- updateCollectionDetail_type :: Lens' UpdateCollectionDetail (Maybe CollectionType)
- data UpdateVpcEndpointDetail = UpdateVpcEndpointDetail' {}
- newUpdateVpcEndpointDetail :: UpdateVpcEndpointDetail
- updateVpcEndpointDetail_id :: Lens' UpdateVpcEndpointDetail (Maybe Text)
- updateVpcEndpointDetail_lastModifiedDate :: Lens' UpdateVpcEndpointDetail (Maybe Integer)
- updateVpcEndpointDetail_name :: Lens' UpdateVpcEndpointDetail (Maybe Text)
- updateVpcEndpointDetail_securityGroupIds :: Lens' UpdateVpcEndpointDetail (Maybe (NonEmpty Text))
- updateVpcEndpointDetail_status :: Lens' UpdateVpcEndpointDetail (Maybe VpcEndpointStatus)
- updateVpcEndpointDetail_subnetIds :: Lens' UpdateVpcEndpointDetail (Maybe (NonEmpty Text))
- data VpcEndpointDetail = VpcEndpointDetail' {}
- newVpcEndpointDetail :: VpcEndpointDetail
- vpcEndpointDetail_createdDate :: Lens' VpcEndpointDetail (Maybe Integer)
- vpcEndpointDetail_id :: Lens' VpcEndpointDetail (Maybe Text)
- vpcEndpointDetail_name :: Lens' VpcEndpointDetail (Maybe Text)
- vpcEndpointDetail_securityGroupIds :: Lens' VpcEndpointDetail (Maybe (NonEmpty Text))
- vpcEndpointDetail_status :: Lens' VpcEndpointDetail (Maybe VpcEndpointStatus)
- vpcEndpointDetail_subnetIds :: Lens' VpcEndpointDetail (Maybe (NonEmpty Text))
- vpcEndpointDetail_vpcId :: Lens' VpcEndpointDetail (Maybe Text)
- data VpcEndpointErrorDetail = VpcEndpointErrorDetail' {}
- newVpcEndpointErrorDetail :: VpcEndpointErrorDetail
- vpcEndpointErrorDetail_errorCode :: Lens' VpcEndpointErrorDetail (Maybe Text)
- vpcEndpointErrorDetail_errorMessage :: Lens' VpcEndpointErrorDetail (Maybe Text)
- vpcEndpointErrorDetail_id :: Lens' VpcEndpointErrorDetail (Maybe Text)
- data VpcEndpointFilters = VpcEndpointFilters' {}
- newVpcEndpointFilters :: VpcEndpointFilters
- vpcEndpointFilters_status :: Lens' VpcEndpointFilters (Maybe VpcEndpointStatus)
- data VpcEndpointSummary = VpcEndpointSummary' {}
- newVpcEndpointSummary :: VpcEndpointSummary
- vpcEndpointSummary_id :: Lens' VpcEndpointSummary (Maybe Text)
- vpcEndpointSummary_name :: Lens' VpcEndpointSummary (Maybe Text)
- vpcEndpointSummary_status :: Lens' VpcEndpointSummary (Maybe VpcEndpointStatus)
Service Configuration
defaultService :: Service Source #
API version 2021-11-01 of the Amazon OpenSearch Service Serverless SDK configuration.
Errors
_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 :: AsError a => Fold a ServiceError Source #
Thrown when an error internal to the service occurs while processing a request.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Thrown when accessing or deleting a resource that does not exist.
_ValidationException :: AsError a => Fold a ServiceError Source #
Thrown when the HTTP request contains invalid input or is missing required input.
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' | |
Fields
| |
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.
accessPolicyDetail_createdDate :: Lens' AccessPolicyDetail (Maybe Integer) Source #
The date the policy was created.
accessPolicyDetail_description :: Lens' AccessPolicyDetail (Maybe Text) Source #
The description of the policy.
accessPolicyDetail_lastModifiedDate :: Lens' AccessPolicyDetail (Maybe Integer) Source #
The timestamp of when the policy was last modified.
accessPolicyDetail_name :: Lens' AccessPolicyDetail (Maybe Text) Source #
The name of the policy.
accessPolicyDetail_policy :: Lens' AccessPolicyDetail (Maybe Document) Source #
The JSON policy document without any whitespaces.
accessPolicyDetail_policyVersion :: Lens' AccessPolicyDetail (Maybe Text) Source #
The version of the policy.
accessPolicyDetail_type :: Lens' AccessPolicyDetail (Maybe AccessPolicyType) Source #
The type of access policy.
AccessPolicyStats
data AccessPolicyStats Source #
Statistics for an OpenSearch Serverless access policy.
See: newAccessPolicyStats smart constructor.
Constructors
| AccessPolicyStats' | |
Fields
| |
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.
accessPolicyStats_dataPolicyCount :: Lens' AccessPolicyStats (Maybe Integer) Source #
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' | |
Fields
| |
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.
accessPolicySummary_createdDate :: Lens' AccessPolicySummary (Maybe Integer) Source #
The Epoch time when the access policy was created.
accessPolicySummary_description :: Lens' AccessPolicySummary (Maybe Text) Source #
The description of the access policy.
accessPolicySummary_lastModifiedDate :: Lens' AccessPolicySummary (Maybe Integer) Source #
The date and time when the collection was last modified.
accessPolicySummary_name :: Lens' AccessPolicySummary (Maybe Text) Source #
The name of the access policy.
accessPolicySummary_policyVersion :: Lens' AccessPolicySummary (Maybe Text) Source #
The version of the policy.
accessPolicySummary_type :: Lens' AccessPolicySummary (Maybe AccessPolicyType) Source #
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' | |
Fields | |
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.
accountSettingsDetail_capacityLimits :: Lens' AccountSettingsDetail (Maybe CapacityLimits) Source #
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' | |
Fields
| |
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.
capacityLimits_maxIndexingCapacityInOCU :: Lens' CapacityLimits (Maybe Natural) Source #
The maximum indexing capacity for collections.
capacityLimits_maxSearchCapacityInOCU :: Lens' CapacityLimits (Maybe Natural) Source #
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' | |
Fields
| |
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.
collectionDetail_arn :: Lens' CollectionDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the collection.
collectionDetail_collectionEndpoint :: Lens' CollectionDetail (Maybe Text) Source #
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
collectionDetail_createdDate :: Lens' CollectionDetail (Maybe Integer) Source #
The Epoch time when the collection was created.
collectionDetail_dashboardEndpoint :: Lens' CollectionDetail (Maybe Text) Source #
Collection-specific endpoint used to access OpenSearch Dashboards.
collectionDetail_description :: Lens' CollectionDetail (Maybe Text) Source #
A description of the collection.
collectionDetail_id :: Lens' CollectionDetail (Maybe Text) Source #
A unique identifier for the collection.
collectionDetail_kmsKeyArn :: Lens' CollectionDetail (Maybe Text) Source #
The ARN of the Amazon Web Services KMS key used to encrypt the collection.
collectionDetail_lastModifiedDate :: Lens' CollectionDetail (Maybe Integer) Source #
The date and time when the collection was last modified.
collectionDetail_name :: Lens' CollectionDetail (Maybe Text) Source #
The name of the collection.
collectionDetail_status :: Lens' CollectionDetail (Maybe CollectionStatus) Source #
The current status of the collection.
collectionDetail_type :: Lens' CollectionDetail (Maybe CollectionType) Source #
The type of collection.
CollectionErrorDetail
data CollectionErrorDetail Source #
Error information for an OpenSearch Serverless request.
See: newCollectionErrorDetail smart constructor.
Constructors
| CollectionErrorDetail' | |
Fields
| |
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.
collectionErrorDetail_errorCode :: Lens' CollectionErrorDetail (Maybe Text) Source #
The error code for the request. For example, NOT_FOUND.
collectionErrorDetail_errorMessage :: Lens' CollectionErrorDetail (Maybe Text) Source #
A description of the error. For example,
The specified Collection is not found.
collectionErrorDetail_id :: Lens' CollectionErrorDetail (Maybe Text) Source #
If the request contains collection IDs, the response includes the IDs provided in the request.
collectionErrorDetail_name :: Lens' CollectionErrorDetail (Maybe Text) Source #
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' | |
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.
collectionFilters_name :: Lens' CollectionFilters (Maybe Text) Source #
The name of the collection.
collectionFilters_status :: Lens' CollectionFilters (Maybe CollectionStatus) Source #
The current status of the collection.
CollectionSummary
data CollectionSummary Source #
Details about each OpenSearch Serverless collection.
See: newCollectionSummary smart constructor.
Constructors
| CollectionSummary' | |
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.
collectionSummary_arn :: Lens' CollectionSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the collection.
collectionSummary_id :: Lens' CollectionSummary (Maybe Text) Source #
The unique identifier of the collection.
collectionSummary_name :: Lens' CollectionSummary (Maybe Text) Source #
The name of the collection.
collectionSummary_status :: Lens' CollectionSummary (Maybe CollectionStatus) Source #
The current status of the collection.
CreateCollectionDetail
data CreateCollectionDetail Source #
Details about the created OpenSearch Serverless collection.
See: newCreateCollectionDetail smart constructor.
Constructors
| CreateCollectionDetail' | |
Fields
| |
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.
createCollectionDetail_arn :: Lens' CreateCollectionDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the collection.
createCollectionDetail_createdDate :: Lens' CreateCollectionDetail (Maybe Integer) Source #
The Epoch time when the collection was created.
createCollectionDetail_description :: Lens' CreateCollectionDetail (Maybe Text) Source #
A description of the collection.
createCollectionDetail_id :: Lens' CreateCollectionDetail (Maybe Text) Source #
The unique identifier of the collection.
createCollectionDetail_kmsKeyArn :: Lens' CreateCollectionDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
createCollectionDetail_lastModifiedDate :: Lens' CreateCollectionDetail (Maybe Integer) Source #
The date and time when the collection was last modified.
createCollectionDetail_name :: Lens' CreateCollectionDetail (Maybe Text) Source #
The name of the collection.
createCollectionDetail_status :: Lens' CreateCollectionDetail (Maybe CollectionStatus) Source #
The current status of the collection.
createCollectionDetail_type :: Lens' CreateCollectionDetail (Maybe CollectionType) Source #
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' | |
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.
createVpcEndpointDetail_id :: Lens' CreateVpcEndpointDetail (Maybe Text) Source #
The unique identifier of the endpoint.
createVpcEndpointDetail_name :: Lens' CreateVpcEndpointDetail (Maybe Text) Source #
The name of the endpoint.
createVpcEndpointDetail_status :: Lens' CreateVpcEndpointDetail (Maybe VpcEndpointStatus) Source #
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' | |
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.
deleteCollectionDetail_id :: Lens' DeleteCollectionDetail (Maybe Text) Source #
The unique identifier of the collection.
deleteCollectionDetail_name :: Lens' DeleteCollectionDetail (Maybe Text) Source #
The name of the collection.
deleteCollectionDetail_status :: Lens' DeleteCollectionDetail (Maybe CollectionStatus) Source #
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' | |
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.
deleteVpcEndpointDetail_id :: Lens' DeleteVpcEndpointDetail (Maybe Text) Source #
The unique identifier of the endpoint.
deleteVpcEndpointDetail_name :: Lens' DeleteVpcEndpointDetail (Maybe Text) Source #
The name of the endpoint.
deleteVpcEndpointDetail_status :: Lens' DeleteVpcEndpointDetail (Maybe VpcEndpointStatus) Source #
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.
Constructors
| SamlConfigOptions' | |
Fields
| |
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.
samlConfigOptions_groupAttribute :: Lens' SamlConfigOptions (Maybe Text) Source #
The group attribute for this SAML integration.
samlConfigOptions_sessionTimeout :: Lens' SamlConfigOptions (Maybe Natural) Source #
The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
samlConfigOptions_userAttribute :: Lens' SamlConfigOptions (Maybe Text) Source #
A user attribute for this SAML integration.
samlConfigOptions_metadata :: Lens' SamlConfigOptions Text Source #
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' | |
Fields
| |
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.
securityConfigDetail_configVersion :: Lens' SecurityConfigDetail (Maybe Text) Source #
The version of the security configuration.
securityConfigDetail_createdDate :: Lens' SecurityConfigDetail (Maybe Integer) Source #
The date the configuration was created.
securityConfigDetail_description :: Lens' SecurityConfigDetail (Maybe Text) Source #
The description of the security configuration.
securityConfigDetail_id :: Lens' SecurityConfigDetail (Maybe Text) Source #
The unique identifier of the security configuration.
securityConfigDetail_lastModifiedDate :: Lens' SecurityConfigDetail (Maybe Integer) Source #
The timestamp of when the configuration was last modified.
securityConfigDetail_samlOptions :: Lens' SecurityConfigDetail (Maybe SamlConfigOptions) Source #
SAML options for the security configuration in the form of a key-value map.
securityConfigDetail_type :: Lens' SecurityConfigDetail (Maybe SecurityConfigType) Source #
The type of security configuration.
SecurityConfigStats
data SecurityConfigStats Source #
Statistics for an OpenSearch Serverless security configuration.
See: newSecurityConfigStats smart constructor.
Constructors
| SecurityConfigStats' | |
Fields
| |
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.
securityConfigStats_samlConfigCount :: Lens' SecurityConfigStats (Maybe Integer) Source #
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' | |
Fields
| |
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.
securityConfigSummary_configVersion :: Lens' SecurityConfigSummary (Maybe Text) Source #
The version of the security configuration.
securityConfigSummary_createdDate :: Lens' SecurityConfigSummary (Maybe Integer) Source #
The Epoch time when the security configuration was created.
securityConfigSummary_description :: Lens' SecurityConfigSummary (Maybe Text) Source #
The description of the security configuration.
securityConfigSummary_id :: Lens' SecurityConfigSummary (Maybe Text) Source #
The unique identifier of the security configuration.
securityConfigSummary_lastModifiedDate :: Lens' SecurityConfigSummary (Maybe Integer) Source #
The timestamp of when the configuration was last modified.
securityConfigSummary_type :: Lens' SecurityConfigSummary (Maybe SecurityConfigType) Source #
The type of security configuration.
SecurityPolicyDetail
data SecurityPolicyDetail Source #
Details about an OpenSearch Serverless security policy.
See: newSecurityPolicyDetail smart constructor.
Constructors
| SecurityPolicyDetail' | |
Fields
| |
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.
securityPolicyDetail_createdDate :: Lens' SecurityPolicyDetail (Maybe Integer) Source #
The date the policy was created.
securityPolicyDetail_description :: Lens' SecurityPolicyDetail (Maybe Text) Source #
The description of the security policy.
securityPolicyDetail_lastModifiedDate :: Lens' SecurityPolicyDetail (Maybe Integer) Source #
The timestamp of when the policy was last modified.
securityPolicyDetail_name :: Lens' SecurityPolicyDetail (Maybe Text) Source #
The name of the policy.
securityPolicyDetail_policy :: Lens' SecurityPolicyDetail (Maybe Document) Source #
The JSON policy document without any whitespaces.
securityPolicyDetail_policyVersion :: Lens' SecurityPolicyDetail (Maybe Text) Source #
The version of the policy.
securityPolicyDetail_type :: Lens' SecurityPolicyDetail (Maybe SecurityPolicyType) Source #
The type of security policy.
SecurityPolicyStats
data SecurityPolicyStats Source #
Statistics for an OpenSearch Serverless security policy.
See: newSecurityPolicyStats smart constructor.
Constructors
| SecurityPolicyStats' | |
Fields
| |
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.
securityPolicyStats_encryptionPolicyCount :: Lens' SecurityPolicyStats (Maybe Integer) Source #
The number of encryption policies in the current account.
securityPolicyStats_networkPolicyCount :: Lens' SecurityPolicyStats (Maybe Integer) Source #
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' | |
Fields
| |
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.
securityPolicySummary_createdDate :: Lens' SecurityPolicySummary (Maybe Integer) Source #
The date the policy was created.
securityPolicySummary_description :: Lens' SecurityPolicySummary (Maybe Text) Source #
The description of the security policy.
securityPolicySummary_lastModifiedDate :: Lens' SecurityPolicySummary (Maybe Integer) Source #
The timestamp of when the policy was last modified.
securityPolicySummary_name :: Lens' SecurityPolicySummary (Maybe Text) Source #
The name of the policy.
securityPolicySummary_policyVersion :: Lens' SecurityPolicySummary (Maybe Text) Source #
The version of the policy.
securityPolicySummary_type :: Lens' SecurityPolicySummary (Maybe SecurityPolicyType) Source #
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' | |
Fields
| |
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.
updateCollectionDetail_arn :: Lens' UpdateCollectionDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the collection.
updateCollectionDetail_createdDate :: Lens' UpdateCollectionDetail (Maybe Integer) Source #
The date and time when the collection was created.
updateCollectionDetail_description :: Lens' UpdateCollectionDetail (Maybe Text) Source #
The description of the collection.
updateCollectionDetail_id :: Lens' UpdateCollectionDetail (Maybe Text) Source #
The unique identifier of the collection.
updateCollectionDetail_lastModifiedDate :: Lens' UpdateCollectionDetail (Maybe Integer) Source #
The date and time when the collection was last modified.
updateCollectionDetail_name :: Lens' UpdateCollectionDetail (Maybe Text) Source #
The name of the collection.
updateCollectionDetail_status :: Lens' UpdateCollectionDetail (Maybe CollectionStatus) Source #
The current status of the collection.
updateCollectionDetail_type :: Lens' UpdateCollectionDetail (Maybe CollectionType) Source #
The collection type.
UpdateVpcEndpointDetail
data UpdateVpcEndpointDetail Source #
Update details for an OpenSearch Serverless-managed interface endpoint.
See: newUpdateVpcEndpointDetail smart constructor.
Constructors
| UpdateVpcEndpointDetail' | |
Fields
| |
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.
updateVpcEndpointDetail_id :: Lens' UpdateVpcEndpointDetail (Maybe Text) Source #
The unique identifier of the endpoint.
updateVpcEndpointDetail_lastModifiedDate :: Lens' UpdateVpcEndpointDetail (Maybe Integer) Source #
The timestamp of when the endpoint was last modified.
updateVpcEndpointDetail_name :: Lens' UpdateVpcEndpointDetail (Maybe Text) Source #
The name of the endpoint.
updateVpcEndpointDetail_securityGroupIds :: Lens' UpdateVpcEndpointDetail (Maybe (NonEmpty Text)) Source #
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
updateVpcEndpointDetail_status :: Lens' UpdateVpcEndpointDetail (Maybe VpcEndpointStatus) Source #
The current status of the endpoint update process.
updateVpcEndpointDetail_subnetIds :: Lens' UpdateVpcEndpointDetail (Maybe (NonEmpty Text)) Source #
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' | |
Fields
| |
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
vpcEndpointDetail_createdDate :: Lens' VpcEndpointDetail (Maybe Integer) Source #
The date the endpoint was created.
vpcEndpointDetail_id :: Lens' VpcEndpointDetail (Maybe Text) Source #
The unique identifier of the endpoint.
vpcEndpointDetail_name :: Lens' VpcEndpointDetail (Maybe Text) Source #
The name of the endpoint.
vpcEndpointDetail_securityGroupIds :: Lens' VpcEndpointDetail (Maybe (NonEmpty Text)) Source #
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
vpcEndpointDetail_status :: Lens' VpcEndpointDetail (Maybe VpcEndpointStatus) Source #
The current status of the endpoint.
vpcEndpointDetail_subnetIds :: Lens' VpcEndpointDetail (Maybe (NonEmpty Text)) Source #
The ID of the subnets from which you access OpenSearch Serverless.
vpcEndpointDetail_vpcId :: Lens' VpcEndpointDetail (Maybe Text) Source #
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.
Constructors
| VpcEndpointErrorDetail' | |
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.
vpcEndpointErrorDetail_errorCode :: Lens' VpcEndpointErrorDetail (Maybe Text) Source #
The error code for the failed request.
vpcEndpointErrorDetail_errorMessage :: Lens' VpcEndpointErrorDetail (Maybe Text) Source #
An error message describing the reason for the failure.
vpcEndpointErrorDetail_id :: Lens' VpcEndpointErrorDetail (Maybe Text) Source #
The unique identifier of the VPC endpoint.
VpcEndpointFilters
data VpcEndpointFilters Source #
Filter the results of a ListVpcEndpoints request.
See: newVpcEndpointFilters smart constructor.
Constructors
| VpcEndpointFilters' | |
Fields
| |
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.
vpcEndpointFilters_status :: Lens' VpcEndpointFilters (Maybe VpcEndpointStatus) Source #
The current status of the endpoint.
VpcEndpointSummary
data VpcEndpointSummary Source #
The VPC endpoint object.
See: newVpcEndpointSummary smart constructor.
Constructors
| VpcEndpointSummary' | |
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.
vpcEndpointSummary_id :: Lens' VpcEndpointSummary (Maybe Text) Source #
The unique identifier of the endpoint.
vpcEndpointSummary_name :: Lens' VpcEndpointSummary (Maybe Text) Source #
The name of the endpoint.
vpcEndpointSummary_status :: Lens' VpcEndpointSummary (Maybe VpcEndpointStatus) Source #
The current status of the endpoint.