OpenSearchService

Client

class OpenSearchService.Client

A low-level client representing Amazon OpenSearch Service

Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs .

The endpoint for configuration service requests is region-specific: es.*region* .amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints .

client = session.create_client('opensearch')

These are the available methods:

accept_inbound_connection(**kwargs)

Allows the remote domain owner to accept an inbound cross-cluster connection request.

See also: AWS API Documentation

Request Syntax

response = client.accept_inbound_connection(
    ConnectionId='string'
)
Parameters
ConnectionId (string) --

[REQUIRED]

The ID of the inbound connection you want to accept.

Return type
dict
Returns
Response Syntax
{
    'Connection': {
        'LocalDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'RemoteDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'ConnectionId': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of an `` AcceptInboundConnection `` operation. Contains details about the accepted inbound connection.

    • Connection (dict) --

      The `` InboundConnection `` of the accepted inbound connection.

      • LocalDomainInfo (dict) --

        The `` AWSDomainInformation `` for the local OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • RemoteDomainInfo (dict) --

        The `` AWSDomainInformation `` for the remote OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • ConnectionId (string) --

        The connection ID for the inbound cross-cluster connection.

      • ConnectionStatus (dict) --

        The `` InboundConnectionStatus `` for the outbound connection.

        • StatusCode (string) --

          The state code for the inbound connection. Can be one of the following:

          • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.
          • APPROVED: Inbound connection is pending acceptance by the remote domain owner.
          • PROVISIONING: Inbound connection provisioning is in progress.
          • ACTIVE: Inbound connection is active and ready to use.
          • REJECTING: Inbound connection rejection is in process.
          • REJECTED: Inbound connection is rejected.
          • DELETING: Inbound connection deletion is in progress.
          • DELETED: Inbound connection is deleted and can no longer be used.
        • Message (string) --

          Verbose information for the inbound connection status.

Exceptions

add_tags(**kwargs)

Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.

See also: AWS API Documentation

Request Syntax

response = client.add_tags(
    ARN='string',
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ARN (string) --

    [REQUIRED]

    Specify the ARN of the domain you want to add tags to.

  • TagList (list) --

    [REQUIRED]

    List of Tag to add to the domain.

    • (dict) --

      A key value pair for a resource tag.

      • Key (string) -- [REQUIRED]

        The TagKey , the name of the tag. Tag keys must be unique for the domain to which they are attached.

      • Value (string) -- [REQUIRED]

        The TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns

None

Exceptions

associate_package(**kwargs)

Associates a package with an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

response = client.associate_package(
    PackageID='string',
    DomainName='string'
)
Parameters
  • PackageID (string) --

    [REQUIRED]

    Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

  • DomainName (string) --

    [REQUIRED]

    The name of the domain to associate the package with.

Return type

dict

Returns

Response Syntax

{
    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
        'PackageVersion': 'string',
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for the response returned by `` AssociatePackage `` operation.

    • DomainPackageDetails (dict) --

      DomainPackageDetails

      • PackageID (string) --

        The internal ID of the package.

      • PackageName (string) --

        User-specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • LastUpdated (datetime) --

        The timestamp of the most recent update to the package association status.

      • DomainName (string) --

        The name of the domain you've associated a package with.

      • DomainPackageStatus (string) --

        State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

      • PackageVersion (string) --

      • ReferencePath (string) --

        The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

      • ErrorDetails (dict) --

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) --
        • ErrorMessage (string) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_service_software_update(**kwargs)

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

See also: AWS API Documentation

Request Syntax

response = client.cancel_service_software_update(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The name of the domain that you want to stop the latest service software update on.

Return type
dict
Returns
Response Syntax
{
    'ServiceSoftwareOptions': {
        'CurrentVersion': 'string',
        'NewVersion': 'string',
        'UpdateAvailable': True|False,
        'Cancellable': True|False,
        'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
        'Description': 'string',
        'AutomatedUpdateDate': datetime(2015, 1, 1),
        'OptionalDeployment': True|False
    }
}

Response Structure

  • (dict) --

    The result of a CancelServiceSoftwareUpdate operation. Contains the status of the update.

    • ServiceSoftwareOptions (dict) --

      The current status of the OpenSearch service software update.

      • CurrentVersion (string) --

        The current service software version present on the domain.

      • NewVersion (string) --

        The new service software version if one is available.

      • UpdateAvailable (boolean) --
        True if you're able to update your service software version. False if you can't update your service software version.
      • Cancellable (boolean) --
        True if you're able to cancel your service software version update. False if you can't cancel your service software update.
      • UpdateStatus (string) --

        The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

      • Description (string) --

        The description of the UpdateStatus .

      • AutomatedUpdateDate (datetime) --

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) --
        True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .

Exceptions

create_domain(**kwargs)

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    DomainName='string',
    EngineVersion='string',
    ClusterConfig={
        'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'InstanceCount': 123,
        'DedicatedMasterEnabled': True|False,
        'ZoneAwarenessEnabled': True|False,
        'ZoneAwarenessConfig': {
            'AvailabilityZoneCount': 123
        },
        'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'DedicatedMasterCount': 123,
        'WarmEnabled': True|False,
        'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
        'WarmCount': 123,
        'ColdStorageOptions': {
            'Enabled': True|False
        }
    },
    EBSOptions={
        'EBSEnabled': True|False,
        'VolumeType': 'standard'|'gp2'|'io1',
        'VolumeSize': 123,
        'Iops': 123
    },
    AccessPolicies='string',
    SnapshotOptions={
        'AutomatedSnapshotStartHour': 123
    },
    VPCOptions={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    CognitoOptions={
        'Enabled': True|False,
        'UserPoolId': 'string',
        'IdentityPoolId': 'string',
        'RoleArn': 'string'
    },
    EncryptionAtRestOptions={
        'Enabled': True|False,
        'KmsKeyId': 'string'
    },
    NodeToNodeEncryptionOptions={
        'Enabled': True|False
    },
    AdvancedOptions={
        'string': 'string'
    },
    LogPublishingOptions={
        'string': {
            'CloudWatchLogsLogGroupArn': 'string',
            'Enabled': True|False
        }
    },
    DomainEndpointOptions={
        'EnforceHTTPS': True|False,
        'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
        'CustomEndpointEnabled': True|False,
        'CustomEndpoint': 'string',
        'CustomEndpointCertificateArn': 'string'
    },
    AdvancedSecurityOptions={
        'Enabled': True|False,
        'InternalUserDatabaseEnabled': True|False,
        'MasterUserOptions': {
            'MasterUserARN': 'string',
            'MasterUserName': 'string',
            'MasterUserPassword': 'string'
        },
        'SAMLOptions': {
            'Enabled': True|False,
            'Idp': {
                'MetadataContent': 'string',
                'EntityId': 'string'
            },
            'MasterUserName': 'string',
            'MasterBackendRole': 'string',
            'SubjectKey': 'string',
            'RolesKey': 'string',
            'SessionTimeoutMinutes': 123
        }
    },
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AutoTuneOptions={
        'DesiredState': 'ENABLED'|'DISABLED',
        'MaintenanceSchedules': [
            {
                'StartAt': datetime(2015, 1, 1),
                'Duration': {
                    'Value': 123,
                    'Unit': 'HOURS'
                },
                'CronExpressionForRecurrence': 'string'
            },
        ]
    }
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • EngineVersion (string) -- String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
  • ClusterConfig (dict) --

    Configuration options for a domain. Specifies the instance type and number of instances in the domain.

    • InstanceType (string) --

      The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

    • InstanceCount (integer) --

      The number of instances in the specified domain cluster.

    • DedicatedMasterEnabled (boolean) --

      A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

    • ZoneAwarenessEnabled (boolean) --

      A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

    • ZoneAwarenessConfig (dict) --

      The zone awareness configuration for a domain when zone awareness is enabled.

      • AvailabilityZoneCount (integer) --

        An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

    • DedicatedMasterType (string) --

      The instance type for a dedicated master node.

    • DedicatedMasterCount (integer) --

      Total number of dedicated master nodes, active and on standby, for the cluster.

    • WarmEnabled (boolean) --

      True to enable UltraWarm storage.

    • WarmType (string) --

      The instance type for the OpenSearch cluster's warm nodes.

    • WarmCount (integer) --

      The number of UltraWarm nodes in the cluster.

    • ColdStorageOptions (dict) --

      Specifies the ColdStorageOptions config for a Domain

      • Enabled (boolean) -- [REQUIRED]

        Enable cold storage option. Accepted values true or false

  • EBSOptions (dict) --

    Options to enable, disable, and specify the type and size of EBS storage volumes.

    • EBSEnabled (boolean) --

      Whether EBS-based storage is enabled.

    • VolumeType (string) --

      The volume type for EBS-based storage.

    • VolumeSize (integer) --

      Integer to specify the size of an EBS volume.

    • Iops (integer) --

      The IOPD for a Provisioned IOPS EBS volume (SSD).

  • AccessPolicies (string) -- IAM access policy as a JSON-formatted string.
  • SnapshotOptions (dict) --

    Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

    • AutomatedSnapshotStartHour (integer) --

      The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

  • VPCOptions (dict) --

    Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

    • SubnetIds (list) --

      The subnets for the VPC endpoint.

      • (string) --
    • SecurityGroupIds (list) --

      The security groups for the VPC endpoint.

      • (string) --
  • CognitoOptions (dict) --

    Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

    • Enabled (boolean) --

      The option to enable Cognito for OpenSearch Dashboards authentication.

    • UserPoolId (string) --

      The Cognito user pool ID for OpenSearch Dashboards authentication.

    • IdentityPoolId (string) --

      The Cognito identity pool ID for OpenSearch Dashboards authentication.

    • RoleArn (string) --

      The role ARN that provides OpenSearch permissions for accessing Cognito resources.

  • EncryptionAtRestOptions (dict) --

    Options for encryption of data at rest.

    • Enabled (boolean) --

      The option to enable encryption at rest.

    • KmsKeyId (string) --

      The KMS key ID for encryption at rest options.

  • NodeToNodeEncryptionOptions (dict) --

    Node-to-node encryption options.

    • Enabled (boolean) --

      True to enable node-to-node encryption.

  • AdvancedOptions (dict) --

    Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced cluster parameters for more information.

    • (string) --
      • (string) --
  • LogPublishingOptions (dict) --

    Map of LogType and LogPublishingOption , each containing options to publish a given type of OpenSearch log.

    • (string) --

      Type of log file. Can be one of the following:

      • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
      • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
      • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
      • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
      • (dict) --

        Log Publishing option that is set for a given domain. Attributes and their details:

        • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
        • Enabled: Whether the log publishing for a given log type is enabled or not.
        • CloudWatchLogsLogGroupArn (string) --

          ARN of the Cloudwatch log group to publish logs to.

        • Enabled (boolean) --

          Whether the given log publishing option is enabled or not.

  • DomainEndpointOptions (dict) --

    Options to specify configurations that will be applied to the domain endpoint.

    • EnforceHTTPS (boolean) --

      Whether only HTTPS endpoint should be enabled for the domain.

    • TLSSecurityPolicy (string) --

      Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

      • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
      • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
    • CustomEndpointEnabled (boolean) --

      Whether to enable a custom endpoint for the domain.

    • CustomEndpoint (string) --

      The fully qualified domain for your custom endpoint.

    • CustomEndpointCertificateArn (string) --

      The ACM certificate ARN for your custom endpoint.

  • AdvancedSecurityOptions (dict) --

    Specifies advanced security options.

    • Enabled (boolean) --

      True if advanced security is enabled.

    • InternalUserDatabaseEnabled (boolean) --

      True if the internal user database is enabled.

    • MasterUserOptions (dict) --

      Credentials for the master user: username and password, ARN, or both.

      • MasterUserARN (string) --

        ARN for the master user (if IAM is enabled).

      • MasterUserName (string) --

        The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.

      • MasterUserPassword (string) --

        The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.

    • SAMLOptions (dict) --

      The SAML application configuration for the domain.

      • Enabled (boolean) --

        True if SAML is enabled.

      • Idp (dict) --

        The SAML Identity Provider's information.

        • MetadataContent (string) -- [REQUIRED]

          The metadata of the SAML application in XML format.

        • EntityId (string) -- [REQUIRED]

          The unique entity ID of the application in SAML identity provider.

      • MasterUserName (string) --

        The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

      • MasterBackendRole (string) --

        The backend role that the SAML master user is mapped to.

      • SubjectKey (string) --

        Element of the SAML assertion to use for username. Default is NameID.

      • RolesKey (string) --

        Element of the SAML assertion to use for backend roles. Default is roles.

      • SessionTimeoutMinutes (integer) --

        The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

  • TagList (list) --

    A list of Tag added during domain creation.

    • (dict) --

      A key value pair for a resource tag.

      • Key (string) -- [REQUIRED]

        The TagKey , the name of the tag. Tag keys must be unique for the domain to which they are attached.

      • Value (string) -- [REQUIRED]

        The TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

  • AutoTuneOptions (dict) --

    Specifies Auto-Tune options.

Return type

dict

Returns

Response Syntax

{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1',
            'VolumeSize': 123,
            'Iops': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            }
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.

    • DomainStatus (dict) --

      The status of the newly created domain.

      • DomainId (string) --

        The unique identifier for the specified domain.

      • DomainName (string) --

        The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • ARN (string) --

        The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

      • Created (boolean) --

        The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

      • Deleted (boolean) --

        The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

      • Endpoint (string) --

        The domain endpoint that you use to submit index and search requests.

      • Endpoints (dict) --

        Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

        • (string) --

          • (string) --

            The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .

      • Processing (boolean) --

        The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.

      • UpgradeProcessing (boolean) --

        The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

      • EngineVersion (string) --

      • ClusterConfig (dict) --

        The type and number of instances in the domain.

        • InstanceType (string) --

          The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

        • InstanceCount (integer) --

          The number of instances in the specified domain cluster.

        • DedicatedMasterEnabled (boolean) --

          A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

        • ZoneAwarenessEnabled (boolean) --

          A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

        • ZoneAwarenessConfig (dict) --

          The zone awareness configuration for a domain when zone awareness is enabled.

          • AvailabilityZoneCount (integer) --

            An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

        • DedicatedMasterType (string) --

          The instance type for a dedicated master node.

        • DedicatedMasterCount (integer) --

          Total number of dedicated master nodes, active and on standby, for the cluster.

        • WarmEnabled (boolean) --

          True to enable UltraWarm storage.

        • WarmType (string) --

          The instance type for the OpenSearch cluster's warm nodes.

        • WarmCount (integer) --

          The number of UltraWarm nodes in the cluster.

        • ColdStorageOptions (dict) --

          Specifies the ColdStorageOptions config for a Domain

          • Enabled (boolean) --

            Enable cold storage option. Accepted values true or false

      • EBSOptions (dict) --

        The EBSOptions for the specified domain.

        • EBSEnabled (boolean) --

          Whether EBS-based storage is enabled.

        • VolumeType (string) --

          The volume type for EBS-based storage.

        • VolumeSize (integer) --

          Integer to specify the size of an EBS volume.

        • Iops (integer) --

          The IOPD for a Provisioned IOPS EBS volume (SSD).

      • AccessPolicies (string) --

        IAM access policy as a JSON-formatted string.

      • SnapshotOptions (dict) --

        The status of the SnapshotOptions .

        • AutomatedSnapshotStartHour (integer) --

          The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

      • VPCOptions (dict) --

        The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

        • VPCId (string) --

          The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

        • SubnetIds (list) --

          The subnets for the VPC endpoint.

          • (string) --
        • AvailabilityZones (list) --

          The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the VPC endpoint.

          • (string) --
      • CognitoOptions (dict) --

        The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

        • Enabled (boolean) --

          The option to enable Cognito for OpenSearch Dashboards authentication.

        • UserPoolId (string) --

          The Cognito user pool ID for OpenSearch Dashboards authentication.

        • IdentityPoolId (string) --

          The Cognito identity pool ID for OpenSearch Dashboards authentication.

        • RoleArn (string) --

          The role ARN that provides OpenSearch permissions for accessing Cognito resources.

      • EncryptionAtRestOptions (dict) --

        The status of the EncryptionAtRestOptions .

        • Enabled (boolean) --

          The option to enable encryption at rest.

        • KmsKeyId (string) --

          The KMS key ID for encryption at rest options.

      • NodeToNodeEncryptionOptions (dict) --

        The status of the NodeToNodeEncryptionOptions .

        • Enabled (boolean) --

          True to enable node-to-node encryption.

      • AdvancedOptions (dict) --

        The status of the AdvancedOptions .

        • (string) --
          • (string) --
      • LogPublishingOptions (dict) --

        Log publishing options for the given domain.

        • (string) --

          Type of log file. Can be one of the following:

          • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
          • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
          • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
          • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
          • (dict) --

            Log Publishing option that is set for a given domain. Attributes and their details:

            • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
            • Enabled: Whether the log publishing for a given log type is enabled or not.
            • CloudWatchLogsLogGroupArn (string) --

              ARN of the Cloudwatch log group to publish logs to.

            • Enabled (boolean) --

              Whether the given log publishing option is enabled or not.

      • ServiceSoftwareOptions (dict) --

        The current status of the domain's service software.

        • CurrentVersion (string) --

          The current service software version present on the domain.

        • NewVersion (string) --

          The new service software version if one is available.

        • UpdateAvailable (boolean) --

          True if you're able to update your service software version. False if you can't update your service software version.

        • Cancellable (boolean) --

          True if you're able to cancel your service software version update. False if you can't cancel your service software update.

        • UpdateStatus (string) --

          The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

        • Description (string) --

          The description of the UpdateStatus .

        • AutomatedUpdateDate (datetime) --

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

        • OptionalDeployment (boolean) --

          True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .

      • DomainEndpointOptions (dict) --

        The current status of the domain's endpoint options.

        • EnforceHTTPS (boolean) --

          Whether only HTTPS endpoint should be enabled for the domain.

        • TLSSecurityPolicy (string) --

          Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

          • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
          • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
        • CustomEndpointEnabled (boolean) --

          Whether to enable a custom endpoint for the domain.

        • CustomEndpoint (string) --

          The fully qualified domain for your custom endpoint.

        • CustomEndpointCertificateArn (string) --

          The ACM certificate ARN for your custom endpoint.

      • AdvancedSecurityOptions (dict) --

        The current status of the domain's advanced security options.

        • Enabled (boolean) --

          True if advanced security is enabled.

        • InternalUserDatabaseEnabled (boolean) --

          True if the internal user database is enabled.

        • SAMLOptions (dict) --

          Describes the SAML application configured for a domain.

          • Enabled (boolean) --

            True if SAML is enabled.

          • Idp (dict) --

            Describes the SAML identity provider's information.

            • MetadataContent (string) --

              The metadata of the SAML application in XML format.

            • EntityId (string) --

              The unique entity ID of the application in SAML identity provider.

          • SubjectKey (string) --

            The key used for matching the SAML subject attribute.

          • RolesKey (string) --

            The key used for matching the SAML roles attribute.

          • SessionTimeoutMinutes (integer) --

            The duration, in minutes, after which a user session becomes inactive.

      • AutoTuneOptions (dict) --

        The current status of the domain's Auto-Tune options.

        • State (string) --

          The AutoTuneState for the domain.

        • ErrorMessage (string) --

          The error message while enabling or disabling Auto-Tune.

Exceptions

create_outbound_connection(**kwargs)

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.

See also: AWS API Documentation

Request Syntax

response = client.create_outbound_connection(
    LocalDomainInfo={
        'AWSDomainInformation': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        }
    },
    RemoteDomainInfo={
        'AWSDomainInformation': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        }
    },
    ConnectionAlias='string'
)
Parameters
  • LocalDomainInfo (dict) --

    [REQUIRED]

    The `` AWSDomainInformation `` for the local OpenSearch domain.

    • AWSDomainInformation (dict) --
      • OwnerId (string) --
      • DomainName (string) -- [REQUIRED]

        The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • Region (string) --
  • RemoteDomainInfo (dict) --

    [REQUIRED]

    The `` AWSDomainInformation `` for the remote OpenSearch domain.

    • AWSDomainInformation (dict) --
      • OwnerId (string) --
      • DomainName (string) -- [REQUIRED]

        The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • Region (string) --
  • ConnectionAlias (string) --

    [REQUIRED]

    The connection alias used used by the customer for this cross-cluster connection.

Return type

dict

Returns

Response Syntax

{
    'LocalDomainInfo': {
        'AWSDomainInformation': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        }
    },
    'RemoteDomainInfo': {
        'AWSDomainInformation': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        }
    },
    'ConnectionAlias': 'string',
    'ConnectionStatus': {
        'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
        'Message': 'string'
    },
    'ConnectionId': 'string'
}

Response Structure

  • (dict) --

    The result of a `` CreateOutboundConnection `` request. Contains the details about the newly created cross-cluster connection.

    • LocalDomainInfo (dict) --

      The `` AWSDomainInformation `` for the local OpenSearch domain.

      • AWSDomainInformation (dict) --

        • OwnerId (string) --

        • DomainName (string) --

          The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • Region (string) --

    • RemoteDomainInfo (dict) --

      The `` AWSDomainInformation `` for the remote OpenSearch domain.

      • AWSDomainInformation (dict) --

        • OwnerId (string) --

        • DomainName (string) --

          The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • Region (string) --

    • ConnectionAlias (string) --

      The connection alias provided during the create connection request.

    • ConnectionStatus (dict) --

      The `` OutboundConnectionStatus `` for the newly created connection.

      • StatusCode (string) --

        The state code for the outbound connection. Can be one of the following:

        • VALIDATING: The outbound connection request is being validated.
        • VALIDATION_FAILED: Validation failed for the connection request.
        • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
        • APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.
        • PROVISIONING: Outbound connection request is in process.
        • ACTIVE: Outbound connection is active and ready to use.
        • REJECTING: Outbound connection rejection by remote domain owner is in progress.
        • REJECTED: Outbound connection request is rejected by remote domain owner.
        • DELETING: Outbound connection deletion is in progress.
        • DELETED: Outbound connection is deleted and can no longer be used.
      • Message (string) --

        Verbose information for the outbound connection status.

    • ConnectionId (string) --

      The unique ID for the created outbound connection, which is used for subsequent operations on the connection.

Exceptions

create_package(**kwargs)

Create a package for use with Amazon OpenSearch Service domains.

See also: AWS API Documentation

Request Syntax

response = client.create_package(
    PackageName='string',
    PackageType='TXT-DICTIONARY',
    PackageDescription='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    }
)
Parameters
  • PackageName (string) --

    [REQUIRED]

    Unique identifier for the package.

  • PackageType (string) --

    [REQUIRED]

    Type of package. Currently supports only TXT-DICTIONARY.

  • PackageDescription (string) -- Description of the package.
  • PackageSource (dict) --

    [REQUIRED]

    The Amazon S3 location from which to import the package.

    • S3BucketName (string) --

      The name of the Amazon S3 bucket containing the package.

    • S3Key (string) --

      Key (file name) of the package.

Return type

dict

Returns

Response Syntax

{
    'PackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'PackageDescription': 'string',
        'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'AvailablePackageVersion': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for the response returned by the `` CreatePackage `` operation.

    • PackageDetails (dict) --

      Information about the package.

      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User-specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • PackageDescription (string) --

        User-specified description of the package.

      • PackageStatus (string) --

        Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

      • CreatedAt (datetime) --

        The timestamp of when the package was created.

      • LastUpdatedAt (datetime) --

      • AvailablePackageVersion (string) --

      • ErrorDetails (dict) --

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) --
        • ErrorMessage (string) --

Exceptions

delete_domain(**kwargs)

Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The name of the domain you want to permanently delete.

Return type
dict
Returns
Response Syntax
{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1',
            'VolumeSize': 123,
            'Iops': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            }
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

    • DomainStatus (dict) --

      The status of the domain being deleted.

      • DomainId (string) --

        The unique identifier for the specified domain.

      • DomainName (string) --

        The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • ARN (string) --

        The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

      • Created (boolean) --

        The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

      • Deleted (boolean) --

        The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

      • Endpoint (string) --

        The domain endpoint that you use to submit index and search requests.

      • Endpoints (dict) --

        Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

        • (string) --
          • (string) --

            The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .

      • Processing (boolean) --

        The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.

      • UpgradeProcessing (boolean) --

        The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

      • EngineVersion (string) --
      • ClusterConfig (dict) --

        The type and number of instances in the domain.

        • InstanceType (string) --

          The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

        • InstanceCount (integer) --

          The number of instances in the specified domain cluster.

        • DedicatedMasterEnabled (boolean) --

          A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

        • ZoneAwarenessEnabled (boolean) --

          A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

        • ZoneAwarenessConfig (dict) --

          The zone awareness configuration for a domain when zone awareness is enabled.

          • AvailabilityZoneCount (integer) --

            An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

        • DedicatedMasterType (string) --

          The instance type for a dedicated master node.

        • DedicatedMasterCount (integer) --

          Total number of dedicated master nodes, active and on standby, for the cluster.

        • WarmEnabled (boolean) --

          True to enable UltraWarm storage.

        • WarmType (string) --

          The instance type for the OpenSearch cluster's warm nodes.

        • WarmCount (integer) --

          The number of UltraWarm nodes in the cluster.

        • ColdStorageOptions (dict) --

          Specifies the ColdStorageOptions config for a Domain

          • Enabled (boolean) --

            Enable cold storage option. Accepted values true or false

      • EBSOptions (dict) --

        The EBSOptions for the specified domain.

        • EBSEnabled (boolean) --

          Whether EBS-based storage is enabled.

        • VolumeType (string) --

          The volume type for EBS-based storage.

        • VolumeSize (integer) --

          Integer to specify the size of an EBS volume.

        • Iops (integer) --

          The IOPD for a Provisioned IOPS EBS volume (SSD).

      • AccessPolicies (string) --

        IAM access policy as a JSON-formatted string.

      • SnapshotOptions (dict) --

        The status of the SnapshotOptions .

        • AutomatedSnapshotStartHour (integer) --

          The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

      • VPCOptions (dict) --

        The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

        • VPCId (string) --

          The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

        • SubnetIds (list) --

          The subnets for the VPC endpoint.

          • (string) --
        • AvailabilityZones (list) --

          The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the VPC endpoint.

          • (string) --
      • CognitoOptions (dict) --

        The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

        • Enabled (boolean) --

          The option to enable Cognito for OpenSearch Dashboards authentication.

        • UserPoolId (string) --

          The Cognito user pool ID for OpenSearch Dashboards authentication.

        • IdentityPoolId (string) --

          The Cognito identity pool ID for OpenSearch Dashboards authentication.

        • RoleArn (string) --

          The role ARN that provides OpenSearch permissions for accessing Cognito resources.

      • EncryptionAtRestOptions (dict) --

        The status of the EncryptionAtRestOptions .

        • Enabled (boolean) --

          The option to enable encryption at rest.

        • KmsKeyId (string) --

          The KMS key ID for encryption at rest options.

      • NodeToNodeEncryptionOptions (dict) --

        The status of the NodeToNodeEncryptionOptions .

        • Enabled (boolean) --

          True to enable node-to-node encryption.

      • AdvancedOptions (dict) --

        The status of the AdvancedOptions .

        • (string) --
          • (string) --
      • LogPublishingOptions (dict) --

        Log publishing options for the given domain.

        • (string) --

          Type of log file. Can be one of the following:

          • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
          • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
          • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
          • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
          • (dict) --

            Log Publishing option that is set for a given domain. Attributes and their details:

            • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
            • Enabled: Whether the log publishing for a given log type is enabled or not.
            • CloudWatchLogsLogGroupArn (string) --

              ARN of the Cloudwatch log group to publish logs to.

            • Enabled (boolean) --

              Whether the given log publishing option is enabled or not.

      • ServiceSoftwareOptions (dict) --

        The current status of the domain's service software.

        • CurrentVersion (string) --

          The current service software version present on the domain.

        • NewVersion (string) --

          The new service software version if one is available.

        • UpdateAvailable (boolean) --
          True if you're able to update your service software version. False if you can't update your service software version.
        • Cancellable (boolean) --
          True if you're able to cancel your service software version update. False if you can't cancel your service software update.
        • UpdateStatus (string) --

          The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

        • Description (string) --

          The description of the UpdateStatus .

        • AutomatedUpdateDate (datetime) --

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

        • OptionalDeployment (boolean) --
          True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
      • DomainEndpointOptions (dict) --

        The current status of the domain's endpoint options.

        • EnforceHTTPS (boolean) --

          Whether only HTTPS endpoint should be enabled for the domain.

        • TLSSecurityPolicy (string) --

          Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

          • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
          • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
        • CustomEndpointEnabled (boolean) --

          Whether to enable a custom endpoint for the domain.

        • CustomEndpoint (string) --

          The fully qualified domain for your custom endpoint.

        • CustomEndpointCertificateArn (string) --

          The ACM certificate ARN for your custom endpoint.

      • AdvancedSecurityOptions (dict) --

        The current status of the domain's advanced security options.

        • Enabled (boolean) --

          True if advanced security is enabled.

        • InternalUserDatabaseEnabled (boolean) --

          True if the internal user database is enabled.

        • SAMLOptions (dict) --

          Describes the SAML application configured for a domain.

          • Enabled (boolean) --

            True if SAML is enabled.

          • Idp (dict) --

            Describes the SAML identity provider's information.

            • MetadataContent (string) --

              The metadata of the SAML application in XML format.

            • EntityId (string) --

              The unique entity ID of the application in SAML identity provider.

          • SubjectKey (string) --

            The key used for matching the SAML subject attribute.

          • RolesKey (string) --

            The key used for matching the SAML roles attribute.

          • SessionTimeoutMinutes (integer) --

            The duration, in minutes, after which a user session becomes inactive.

      • AutoTuneOptions (dict) --

        The current status of the domain's Auto-Tune options.

        • State (string) --

          The AutoTuneState for the domain.

        • ErrorMessage (string) --

          The error message while enabling or disabling Auto-Tune.

Exceptions

delete_inbound_connection(**kwargs)

Allows the remote domain owner to delete an existing inbound cross-cluster connection.

See also: AWS API Documentation

Request Syntax

response = client.delete_inbound_connection(
    ConnectionId='string'
)
Parameters
ConnectionId (string) --

[REQUIRED]

The ID of the inbound connection to permanently delete.

Return type
dict
Returns
Response Syntax
{
    'Connection': {
        'LocalDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'RemoteDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'ConnectionId': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of a `` DeleteInboundConnection `` operation. Contains details about the deleted inbound connection.

    • Connection (dict) --

      The `` InboundConnection `` of the deleted inbound connection.

      • LocalDomainInfo (dict) --

        The `` AWSDomainInformation `` for the local OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • RemoteDomainInfo (dict) --

        The `` AWSDomainInformation `` for the remote OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • ConnectionId (string) --

        The connection ID for the inbound cross-cluster connection.

      • ConnectionStatus (dict) --

        The `` InboundConnectionStatus `` for the outbound connection.

        • StatusCode (string) --

          The state code for the inbound connection. Can be one of the following:

          • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.
          • APPROVED: Inbound connection is pending acceptance by the remote domain owner.
          • PROVISIONING: Inbound connection provisioning is in progress.
          • ACTIVE: Inbound connection is active and ready to use.
          • REJECTING: Inbound connection rejection is in process.
          • REJECTED: Inbound connection is rejected.
          • DELETING: Inbound connection deletion is in progress.
          • DELETED: Inbound connection is deleted and can no longer be used.
        • Message (string) --

          Verbose information for the inbound connection status.

Exceptions

delete_outbound_connection(**kwargs)

Allows the local domain owner to delete an existing outbound cross-cluster connection.

See also: AWS API Documentation

Request Syntax

response = client.delete_outbound_connection(
    ConnectionId='string'
)
Parameters
ConnectionId (string) --

[REQUIRED]

The ID of the outbound connection you want to permanently delete.

Return type
dict
Returns
Response Syntax
{
    'Connection': {
        'LocalDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'RemoteDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'ConnectionId': 'string',
        'ConnectionAlias': 'string',
        'ConnectionStatus': {
            'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of a `` DeleteOutboundConnection `` operation. Contains details about the deleted outbound connection.

    • Connection (dict) --

      The `` OutboundConnection `` of the deleted outbound connection.

      • LocalDomainInfo (dict) --

        The `` DomainInformation `` for the local OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • RemoteDomainInfo (dict) --

        The `` DomainInformation `` for the remote OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • ConnectionId (string) --

        The connection ID for the outbound cross-cluster connection.

      • ConnectionAlias (string) --

        The connection alias for the outbound cross-cluster connection.

      • ConnectionStatus (dict) --

        The `` OutboundConnectionStatus `` for the outbound connection.

        • StatusCode (string) --

          The state code for the outbound connection. Can be one of the following:

          • VALIDATING: The outbound connection request is being validated.
          • VALIDATION_FAILED: Validation failed for the connection request.
          • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
          • APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.
          • PROVISIONING: Outbound connection request is in process.
          • ACTIVE: Outbound connection is active and ready to use.
          • REJECTING: Outbound connection rejection by remote domain owner is in progress.
          • REJECTED: Outbound connection request is rejected by remote domain owner.
          • DELETING: Outbound connection deletion is in progress.
          • DELETED: Outbound connection is deleted and can no longer be used.
        • Message (string) --

          Verbose information for the outbound connection status.

Exceptions

delete_package(**kwargs)

Deletes the package.

See also: AWS API Documentation

Request Syntax

response = client.delete_package(
    PackageID='string'
)
Parameters
PackageID (string) --

[REQUIRED]

The internal ID of the package you want to delete. Use DescribePackages to find this value.

Return type
dict
Returns
Response Syntax
{
    'PackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'PackageDescription': 'string',
        'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'AvailablePackageVersion': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for the response parameters to the `` DeletePackage `` operation.

    • PackageDetails (dict) --
      PackageDetails
      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User-specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • PackageDescription (string) --

        User-specified description of the package.

      • PackageStatus (string) --

        Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

      • CreatedAt (datetime) --

        The timestamp of when the package was created.

      • LastUpdatedAt (datetime) --
      • AvailablePackageVersion (string) --
      • ErrorDetails (dict) --

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) --
        • ErrorMessage (string) --

Exceptions

describe_domain(**kwargs)

Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The name of the domain for which you want information.

Return type
dict
Returns
Response Syntax
{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1',
            'VolumeSize': 123,
            'Iops': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            }
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of a DescribeDomain request. Contains the status of the domain specified in the request.

    • DomainStatus (dict) --

      The current status of the domain.

      • DomainId (string) --

        The unique identifier for the specified domain.

      • DomainName (string) --

        The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • ARN (string) --

        The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

      • Created (boolean) --

        The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

      • Deleted (boolean) --

        The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

      • Endpoint (string) --

        The domain endpoint that you use to submit index and search requests.

      • Endpoints (dict) --

        Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

        • (string) --
          • (string) --

            The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .

      • Processing (boolean) --

        The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.

      • UpgradeProcessing (boolean) --

        The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

      • EngineVersion (string) --
      • ClusterConfig (dict) --

        The type and number of instances in the domain.

        • InstanceType (string) --

          The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

        • InstanceCount (integer) --

          The number of instances in the specified domain cluster.

        • DedicatedMasterEnabled (boolean) --

          A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

        • ZoneAwarenessEnabled (boolean) --

          A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

        • ZoneAwarenessConfig (dict) --

          The zone awareness configuration for a domain when zone awareness is enabled.

          • AvailabilityZoneCount (integer) --

            An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

        • DedicatedMasterType (string) --

          The instance type for a dedicated master node.

        • DedicatedMasterCount (integer) --

          Total number of dedicated master nodes, active and on standby, for the cluster.

        • WarmEnabled (boolean) --

          True to enable UltraWarm storage.

        • WarmType (string) --

          The instance type for the OpenSearch cluster's warm nodes.

        • WarmCount (integer) --

          The number of UltraWarm nodes in the cluster.

        • ColdStorageOptions (dict) --

          Specifies the ColdStorageOptions config for a Domain

          • Enabled (boolean) --

            Enable cold storage option. Accepted values true or false

      • EBSOptions (dict) --

        The EBSOptions for the specified domain.

        • EBSEnabled (boolean) --

          Whether EBS-based storage is enabled.

        • VolumeType (string) --

          The volume type for EBS-based storage.

        • VolumeSize (integer) --

          Integer to specify the size of an EBS volume.

        • Iops (integer) --

          The IOPD for a Provisioned IOPS EBS volume (SSD).

      • AccessPolicies (string) --

        IAM access policy as a JSON-formatted string.

      • SnapshotOptions (dict) --

        The status of the SnapshotOptions .

        • AutomatedSnapshotStartHour (integer) --

          The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

      • VPCOptions (dict) --

        The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

        • VPCId (string) --

          The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

        • SubnetIds (list) --

          The subnets for the VPC endpoint.

          • (string) --
        • AvailabilityZones (list) --

          The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

          • (string) --
        • SecurityGroupIds (list) --

          The security groups for the VPC endpoint.

          • (string) --
      • CognitoOptions (dict) --

        The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

        • Enabled (boolean) --

          The option to enable Cognito for OpenSearch Dashboards authentication.

        • UserPoolId (string) --

          The Cognito user pool ID for OpenSearch Dashboards authentication.

        • IdentityPoolId (string) --

          The Cognito identity pool ID for OpenSearch Dashboards authentication.

        • RoleArn (string) --

          The role ARN that provides OpenSearch permissions for accessing Cognito resources.

      • EncryptionAtRestOptions (dict) --

        The status of the EncryptionAtRestOptions .

        • Enabled (boolean) --

          The option to enable encryption at rest.

        • KmsKeyId (string) --

          The KMS key ID for encryption at rest options.

      • NodeToNodeEncryptionOptions (dict) --

        The status of the NodeToNodeEncryptionOptions .

        • Enabled (boolean) --

          True to enable node-to-node encryption.

      • AdvancedOptions (dict) --

        The status of the AdvancedOptions .

        • (string) --
          • (string) --
      • LogPublishingOptions (dict) --

        Log publishing options for the given domain.

        • (string) --

          Type of log file. Can be one of the following:

          • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
          • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
          • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
          • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
          • (dict) --

            Log Publishing option that is set for a given domain. Attributes and their details:

            • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
            • Enabled: Whether the log publishing for a given log type is enabled or not.
            • CloudWatchLogsLogGroupArn (string) --

              ARN of the Cloudwatch log group to publish logs to.

            • Enabled (boolean) --

              Whether the given log publishing option is enabled or not.

      • ServiceSoftwareOptions (dict) --

        The current status of the domain's service software.

        • CurrentVersion (string) --

          The current service software version present on the domain.

        • NewVersion (string) --

          The new service software version if one is available.

        • UpdateAvailable (boolean) --
          True if you're able to update your service software version. False if you can't update your service software version.
        • Cancellable (boolean) --
          True if you're able to cancel your service software version update. False if you can't cancel your service software update.
        • UpdateStatus (string) --

          The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

        • Description (string) --

          The description of the UpdateStatus .

        • AutomatedUpdateDate (datetime) --

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

        • OptionalDeployment (boolean) --
          True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
      • DomainEndpointOptions (dict) --

        The current status of the domain's endpoint options.

        • EnforceHTTPS (boolean) --

          Whether only HTTPS endpoint should be enabled for the domain.

        • TLSSecurityPolicy (string) --

          Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

          • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
          • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
        • CustomEndpointEnabled (boolean) --

          Whether to enable a custom endpoint for the domain.

        • CustomEndpoint (string) --

          The fully qualified domain for your custom endpoint.

        • CustomEndpointCertificateArn (string) --

          The ACM certificate ARN for your custom endpoint.

      • AdvancedSecurityOptions (dict) --

        The current status of the domain's advanced security options.

        • Enabled (boolean) --

          True if advanced security is enabled.

        • InternalUserDatabaseEnabled (boolean) --

          True if the internal user database is enabled.

        • SAMLOptions (dict) --

          Describes the SAML application configured for a domain.

          • Enabled (boolean) --

            True if SAML is enabled.

          • Idp (dict) --

            Describes the SAML identity provider's information.

            • MetadataContent (string) --

              The metadata of the SAML application in XML format.

            • EntityId (string) --

              The unique entity ID of the application in SAML identity provider.

          • SubjectKey (string) --

            The key used for matching the SAML subject attribute.

          • RolesKey (string) --

            The key used for matching the SAML roles attribute.

          • SessionTimeoutMinutes (integer) --

            The duration, in minutes, after which a user session becomes inactive.

      • AutoTuneOptions (dict) --

        The current status of the domain's Auto-Tune options.

        • State (string) --

          The AutoTuneState for the domain.

        • ErrorMessage (string) --

          The error message while enabling or disabling Auto-Tune.

Exceptions

describe_domain_auto_tunes(**kwargs)

Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_auto_tunes(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The domain name for which you want Auto-Tune action details.

  • MaxResults (integer) -- Set this value to limit the number of results returned. If not specified, defaults to 100.
  • NextToken (string) -- NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.
Return type

dict

Returns

Response Syntax

{
    'AutoTunes': [
        {
            'AutoTuneType': 'SCHEDULED_ACTION',
            'AutoTuneDetails': {
                'ScheduledAutoTuneDetails': {
                    'Date': datetime(2015, 1, 1),
                    'ActionType': 'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
                    'Action': 'string',
                    'Severity': 'LOW'|'MEDIUM'|'HIGH'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The result of a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service for more information.

    • AutoTunes (list) --

      The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.

      • (dict) --

        Specifies the Auto-Tune type and Auto-Tune action details.

        • AutoTuneType (string) --

          Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

        • AutoTuneDetails (dict) --

          Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

          • ScheduledAutoTuneDetails (dict) --

            Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

            • Date (datetime) --

              The timestamp of the Auto-Tune action scheduled for the domain.

            • ActionType (string) --

              The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

            • Action (string) --

              The Auto-Tune action description.

            • Severity (string) --

              The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.

    • NextToken (string) --

      An identifier to allow retrieval of paginated results.

Exceptions

describe_domain_config(**kwargs)

Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_config(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The domain you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'DomainConfig': {
        'EngineVersion': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'ClusterConfig': {
            'Options': {
                'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'InstanceCount': 123,
                'DedicatedMasterEnabled': True|False,
                'ZoneAwarenessEnabled': True|False,
                'ZoneAwarenessConfig': {
                    'AvailabilityZoneCount': 123
                },
                'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'DedicatedMasterCount': 123,
                'WarmEnabled': True|False,
                'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
                'WarmCount': 123,
                'ColdStorageOptions': {
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EBSOptions': {
            'Options': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1',
                'VolumeSize': 123,
                'Iops': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AccessPolicies': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'SnapshotOptions': {
            'Options': {
                'AutomatedSnapshotStartHour': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'VPCOptions': {
            'Options': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'CognitoOptions': {
            'Options': {
                'Enabled': True|False,
                'UserPoolId': 'string',
                'IdentityPoolId': 'string',
                'RoleArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EncryptionAtRestOptions': {
            'Options': {
                'Enabled': True|False,
                'KmsKeyId': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'NodeToNodeEncryptionOptions': {
            'Options': {
                'Enabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedOptions': {
            'Options': {
                'string': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'LogPublishingOptions': {
            'Options': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'DomainEndpointOptions': {
            'Options': {
                'EnforceHTTPS': True|False,
                'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
                'CustomEndpointEnabled': True|False,
                'CustomEndpoint': 'string',
                'CustomEndpointCertificateArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedSecurityOptions': {
            'Options': {
                'Enabled': True|False,
                'InternalUserDatabaseEnabled': True|False,
                'SAMLOptions': {
                    'Enabled': True|False,
                    'Idp': {
                        'MetadataContent': 'string',
                        'EntityId': 'string'
                    },
                    'SubjectKey': 'string',
                    'RolesKey': 'string',
                    'SessionTimeoutMinutes': 123
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AutoTuneOptions': {
            'Options': {
                'DesiredState': 'ENABLED'|'DISABLED',
                'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
                'MaintenanceSchedules': [
                    {
                        'StartAt': datetime(2015, 1, 1),
                        'Duration': {
                            'Value': 123,
                            'Unit': 'HOURS'
                        },
                        'CronExpressionForRecurrence': 'string'
                    },
                ]
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
                'ErrorMessage': 'string',
                'PendingDeletion': True|False
            }
        }
    }
}

Response Structure

  • (dict) --

    The result of a DescribeDomainConfig request. Contains the configuration information of the requested domain.

    • DomainConfig (dict) --

      The configuration information of the domain requested in the DescribeDomainConfig request.

      • EngineVersion (dict) --

        String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

        • Options (string) --

          The OpenSearch version for the specified OpenSearch domain.

        • Status (dict) --

          The status of the OpenSearch version options for the specified OpenSearch domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • ClusterConfig (dict) --

        The ClusterConfig for the domain.

        • Options (dict) --

          The cluster configuration for the specified domain.

          • InstanceType (string) --

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

          • InstanceCount (integer) --

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled (boolean) --

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled (boolean) --

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig (dict) --

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount (integer) --

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType (string) --

            The instance type for a dedicated master node.

          • DedicatedMasterCount (integer) --

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled (boolean) --

            True to enable UltraWarm storage.

          • WarmType (string) --

            The instance type for the OpenSearch cluster's warm nodes.

          • WarmCount (integer) --

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions (dict) --

            Specifies the ColdStorageOptions config for a Domain

            • Enabled (boolean) --

              Enable cold storage option. Accepted values true or false

        • Status (dict) --

          The cluster configuration status for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • EBSOptions (dict) --

        The EBSOptions for the domain.

        • Options (dict) --

          The EBS options for the specified domain.

          • EBSEnabled (boolean) --

            Whether EBS-based storage is enabled.

          • VolumeType (string) --

            The volume type for EBS-based storage.

          • VolumeSize (integer) --

            Integer to specify the size of an EBS volume.

          • Iops (integer) --

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • Status (dict) --

          The status of the EBS options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AccessPolicies (dict) --

        IAM access policy as a JSON-formatted string.

        • Options (string) --

          The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policies for more information.

        • Status (dict) --

          The status of the access policy for the domain. See OptionStatus for the status information that's included.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • SnapshotOptions (dict) --

        The SnapshotOptions for the domain.

        • Options (dict) --

          The daily snapshot options specified for the domain.

          • AutomatedSnapshotStartHour (integer) --

            The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • Status (dict) --

          The status of a daily automated snapshot.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • VPCOptions (dict) --

        The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

        • Options (dict) --

          The VPC options for the specified domain.

          • VPCId (string) --

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

          • SubnetIds (list) --

            The subnets for the VPC endpoint.

            • (string) --
          • AvailabilityZones (list) --

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

            • (string) --
          • SecurityGroupIds (list) --

            The security groups for the VPC endpoint.

            • (string) --
        • Status (dict) --

          The status of the VPC options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • CognitoOptions (dict) --

        The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

        • Options (dict) --

          Cognito options for the specified domain.

          • Enabled (boolean) --

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId (string) --

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId (string) --

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn (string) --

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • Status (dict) --

          The status of the Cognito options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • EncryptionAtRestOptions (dict) --

        The EncryptionAtRestOptions for the domain.

        • Options (dict) --

          The Encryption At Rest options for the specified domain.

          • Enabled (boolean) --

            The option to enable encryption at rest.

          • KmsKeyId (string) --

            The KMS key ID for encryption at rest options.

        • Status (dict) --

          The status of the Encryption At Rest options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • NodeToNodeEncryptionOptions (dict) --

        The NodeToNodeEncryptionOptions for the domain.

        • Options (dict) --

          The node-to-node encryption options for the specified domain.

          • Enabled (boolean) --

            True to enable node-to-node encryption.

        • Status (dict) --

          The status of the node-to-node encryption options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AdvancedOptions (dict) --

        The AdvancedOptions for the domain. See Advanced options for more information.

        • Options (dict) --

          The status of advanced options for the specified domain.

          • (string) --
            • (string) --
        • Status (dict) --

          The OptionStatus for advanced options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • LogPublishingOptions (dict) --

        Log publishing options for the given domain.

        • Options (dict) --

          The log publishing options configured for the domain.

          • (string) --

            Type of log file. Can be one of the following:

            • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
            • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
            • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
            • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
            • (dict) --

              Log Publishing option that is set for a given domain. Attributes and their details:

              • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
              • Enabled: Whether the log publishing for a given log type is enabled or not.
              • CloudWatchLogsLogGroupArn (string) --

                ARN of the Cloudwatch log group to publish logs to.

              • Enabled (boolean) --

                Whether the given log publishing option is enabled or not.

        • Status (dict) --

          The status of the log publishing options for the domain. See OptionStatus for the status information that's included.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • DomainEndpointOptions (dict) --

        The DomainEndpointOptions for the domain.

        • Options (dict) --

          Options to configure the endpoint for the domain.

          • EnforceHTTPS (boolean) --

            Whether only HTTPS endpoint should be enabled for the domain.

          • TLSSecurityPolicy (string) --

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
          • CustomEndpointEnabled (boolean) --

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint (string) --

            The fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn (string) --

            The ACM certificate ARN for your custom endpoint.

        • Status (dict) --

          The status of the endpoint options for the domain. See OptionStatus for the status information that's included.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AdvancedSecurityOptions (dict) --

        Specifies AdvancedSecurityOptions for the domain.

        • Options (dict) --

          Advanced security options for the specified domain.

          • Enabled (boolean) --

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled (boolean) --

            True if the internal user database is enabled.

          • SAMLOptions (dict) --

            Describes the SAML application configured for a domain.

            • Enabled (boolean) --

              True if SAML is enabled.

            • Idp (dict) --

              Describes the SAML identity provider's information.

              • MetadataContent (string) --

                The metadata of the SAML application in XML format.

              • EntityId (string) --

                The unique entity ID of the application in SAML identity provider.

            • SubjectKey (string) --

              The key used for matching the SAML subject attribute.

            • RolesKey (string) --

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes (integer) --

              The duration, in minutes, after which a user session becomes inactive.

        • Status (dict) --

          Status of the advanced security options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AutoTuneOptions (dict) --

        Specifies AutoTuneOptions for the domain.

        • Options (dict) --

          Specifies Auto-Tune options for the domain.

          • DesiredState (string) --

            The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

          • RollbackOnDisable (string) --

            The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

          • MaintenanceSchedules (list) --

            A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

        • Status (dict) --

          The status of the Auto-Tune options for the domain.

          • CreationDate (datetime) --

            The timestamp of the Auto-Tune options creation date.

          • UpdateDate (datetime) --

            The timestamp of when the Auto-Tune options were last updated.

          • UpdateVersion (integer) --

            The latest version of the Auto-Tune options.

          • State (string) --

            The AutoTuneState for the domain.

          • ErrorMessage (string) --

            The error message while enabling or disabling Auto-Tune.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

Exceptions

describe_domains(**kwargs)

Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.

See also: AWS API Documentation

Request Syntax

response = client.describe_domains(
    DomainNames=[
        'string',
    ]
)
Parameters
DomainNames (list) --

[REQUIRED]

The domains for which you want information.

  • (string) --

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type
dict
Returns
Response Syntax
{
    'DomainStatusList': [
        {
            'DomainId': 'string',
            'DomainName': 'string',
            'ARN': 'string',
            'Created': True|False,
            'Deleted': True|False,
            'Endpoint': 'string',
            'Endpoints': {
                'string': 'string'
            },
            'Processing': True|False,
            'UpgradeProcessing': True|False,
            'EngineVersion': 'string',
            'ClusterConfig': {
                'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'InstanceCount': 123,
                'DedicatedMasterEnabled': True|False,
                'ZoneAwarenessEnabled': True|False,
                'ZoneAwarenessConfig': {
                    'AvailabilityZoneCount': 123
                },
                'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'DedicatedMasterCount': 123,
                'WarmEnabled': True|False,
                'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
                'WarmCount': 123,
                'ColdStorageOptions': {
                    'Enabled': True|False
                }
            },
            'EBSOptions': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1',
                'VolumeSize': 123,
                'Iops': 123
            },
            'AccessPolicies': 'string',
            'SnapshotOptions': {
                'AutomatedSnapshotStartHour': 123
            },
            'VPCOptions': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'CognitoOptions': {
                'Enabled': True|False,
                'UserPoolId': 'string',
                'IdentityPoolId': 'string',
                'RoleArn': 'string'
            },
            'EncryptionAtRestOptions': {
                'Enabled': True|False,
                'KmsKeyId': 'string'
            },
            'NodeToNodeEncryptionOptions': {
                'Enabled': True|False
            },
            'AdvancedOptions': {
                'string': 'string'
            },
            'LogPublishingOptions': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            },
            'ServiceSoftwareOptions': {
                'CurrentVersion': 'string',
                'NewVersion': 'string',
                'UpdateAvailable': True|False,
                'Cancellable': True|False,
                'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
                'Description': 'string',
                'AutomatedUpdateDate': datetime(2015, 1, 1),
                'OptionalDeployment': True|False
            },
            'DomainEndpointOptions': {
                'EnforceHTTPS': True|False,
                'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
                'CustomEndpointEnabled': True|False,
                'CustomEndpoint': 'string',
                'CustomEndpointCertificateArn': 'string'
            },
            'AdvancedSecurityOptions': {
                'Enabled': True|False,
                'InternalUserDatabaseEnabled': True|False,
                'SAMLOptions': {
                    'Enabled': True|False,
                    'Idp': {
                        'MetadataContent': 'string',
                        'EntityId': 'string'
                    },
                    'SubjectKey': 'string',
                    'RolesKey': 'string',
                    'SessionTimeoutMinutes': 123
                }
            },
            'AutoTuneOptions': {
                'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    The result of a DescribeDomains request. Contains the status of the specified domains or all domains owned by the account.

    • DomainStatusList (list) --

      The status of the domains requested in the DescribeDomains request.

      • (dict) --

        The current status of a domain.

        • DomainId (string) --

          The unique identifier for the specified domain.

        • DomainName (string) --

          The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • ARN (string) --

          The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

        • Created (boolean) --

          The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

        • Deleted (boolean) --

          The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

        • Endpoint (string) --

          The domain endpoint that you use to submit index and search requests.

        • Endpoints (dict) --

          Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

          • (string) --
            • (string) --

              The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .

        • Processing (boolean) --

          The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing (boolean) --

          The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

        • EngineVersion (string) --
        • ClusterConfig (dict) --

          The type and number of instances in the domain.

          • InstanceType (string) --

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

          • InstanceCount (integer) --

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled (boolean) --

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled (boolean) --

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig (dict) --

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount (integer) --

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType (string) --

            The instance type for a dedicated master node.

          • DedicatedMasterCount (integer) --

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled (boolean) --

            True to enable UltraWarm storage.

          • WarmType (string) --

            The instance type for the OpenSearch cluster's warm nodes.

          • WarmCount (integer) --

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions (dict) --

            Specifies the ColdStorageOptions config for a Domain

            • Enabled (boolean) --

              Enable cold storage option. Accepted values true or false

        • EBSOptions (dict) --

          The EBSOptions for the specified domain.

          • EBSEnabled (boolean) --

            Whether EBS-based storage is enabled.

          • VolumeType (string) --

            The volume type for EBS-based storage.

          • VolumeSize (integer) --

            Integer to specify the size of an EBS volume.

          • Iops (integer) --

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • AccessPolicies (string) --

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions (dict) --

          The status of the SnapshotOptions .

          • AutomatedSnapshotStartHour (integer) --

            The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • VPCOptions (dict) --

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

          • VPCId (string) --

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

          • SubnetIds (list) --

            The subnets for the VPC endpoint.

            • (string) --
          • AvailabilityZones (list) --

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

            • (string) --
          • SecurityGroupIds (list) --

            The security groups for the VPC endpoint.

            • (string) --
        • CognitoOptions (dict) --

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

          • Enabled (boolean) --

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId (string) --

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId (string) --

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn (string) --

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions (dict) --

          The status of the EncryptionAtRestOptions .

          • Enabled (boolean) --

            The option to enable encryption at rest.

          • KmsKeyId (string) --

            The KMS key ID for encryption at rest options.

        • NodeToNodeEncryptionOptions (dict) --

          The status of the NodeToNodeEncryptionOptions .

          • Enabled (boolean) --

            True to enable node-to-node encryption.

        • AdvancedOptions (dict) --

          The status of the AdvancedOptions .

          • (string) --
            • (string) --
        • LogPublishingOptions (dict) --

          Log publishing options for the given domain.

          • (string) --

            Type of log file. Can be one of the following:

            • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
            • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
            • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
            • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
            • (dict) --

              Log Publishing option that is set for a given domain. Attributes and their details:

              • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
              • Enabled: Whether the log publishing for a given log type is enabled or not.
              • CloudWatchLogsLogGroupArn (string) --

                ARN of the Cloudwatch log group to publish logs to.

              • Enabled (boolean) --

                Whether the given log publishing option is enabled or not.

        • ServiceSoftwareOptions (dict) --

          The current status of the domain's service software.

          • CurrentVersion (string) --

            The current service software version present on the domain.

          • NewVersion (string) --

            The new service software version if one is available.

          • UpdateAvailable (boolean) --
            True if you're able to update your service software version. False if you can't update your service software version.
          • Cancellable (boolean) --
            True if you're able to cancel your service software version update. False if you can't cancel your service software update.
          • UpdateStatus (string) --

            The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

          • Description (string) --

            The description of the UpdateStatus .

          • AutomatedUpdateDate (datetime) --

            The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

          • OptionalDeployment (boolean) --
            True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
        • DomainEndpointOptions (dict) --

          The current status of the domain's endpoint options.

          • EnforceHTTPS (boolean) --

            Whether only HTTPS endpoint should be enabled for the domain.

          • TLSSecurityPolicy (string) --

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
          • CustomEndpointEnabled (boolean) --

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint (string) --

            The fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn (string) --

            The ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions (dict) --

          The current status of the domain's advanced security options.

          • Enabled (boolean) --

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled (boolean) --

            True if the internal user database is enabled.

          • SAMLOptions (dict) --

            Describes the SAML application configured for a domain.

            • Enabled (boolean) --

              True if SAML is enabled.

            • Idp (dict) --

              Describes the SAML identity provider's information.

              • MetadataContent (string) --

                The metadata of the SAML application in XML format.

              • EntityId (string) --

                The unique entity ID of the application in SAML identity provider.

            • SubjectKey (string) --

              The key used for matching the SAML subject attribute.

            • RolesKey (string) --

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes (integer) --

              The duration, in minutes, after which a user session becomes inactive.

        • AutoTuneOptions (dict) --

          The current status of the domain's Auto-Tune options.

          • State (string) --

            The AutoTuneState for the domain.

          • ErrorMessage (string) --

            The error message while enabling or disabling Auto-Tune.

Exceptions

describe_inbound_connections(**kwargs)

Lists all the inbound cross-cluster connections for a remote domain.

See also: AWS API Documentation

Request Syntax

response = client.describe_inbound_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Filters (list) --

    A list of filters used to match properties for inbound cross-cluster connections. Available `` Filter `` values are:

    • connection-id
    • local-domain-info.domain-name
    • local-domain-info.owner-id
    • local-domain-info.region
    • remote-domain-info.domain-name
    • (dict) --

      A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

      • Name (string) --

        The name of the filter.

      • Values (list) --

        Contains one or more values for the filter.

        • (string) --
  • MaxResults (integer) -- Set this value to limit the number of results returned. If not specified, defaults to 100.
  • NextToken (string) -- If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'LocalDomainInfo': {
                'AWSDomainInformation': {
                    'OwnerId': 'string',
                    'DomainName': 'string',
                    'Region': 'string'
                }
            },
            'RemoteDomainInfo': {
                'AWSDomainInformation': {
                    'OwnerId': 'string',
                    'DomainName': 'string',
                    'Region': 'string'
                }
            },
            'ConnectionId': 'string',
            'ConnectionStatus': {
                'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The result of a `` DescribeInboundConnections `` request. Contains a list of connections matching the filter criteria.

    • Connections (list) --

      A list of `` InboundConnection `` matching the specified filter criteria.

      • (dict) --

        Details of an inbound connection.

        • LocalDomainInfo (dict) --

          The `` AWSDomainInformation `` for the local OpenSearch domain.

          • AWSDomainInformation (dict) --

            • OwnerId (string) --

            • DomainName (string) --

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region (string) --

        • RemoteDomainInfo (dict) --

          The `` AWSDomainInformation `` for the remote OpenSearch domain.

          • AWSDomainInformation (dict) --

            • OwnerId (string) --

            • DomainName (string) --

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region (string) --

        • ConnectionId (string) --

          The connection ID for the inbound cross-cluster connection.

        • ConnectionStatus (dict) --

          The `` InboundConnectionStatus `` for the outbound connection.

          • StatusCode (string) --

            The state code for the inbound connection. Can be one of the following:

            • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.
            • APPROVED: Inbound connection is pending acceptance by the remote domain owner.
            • PROVISIONING: Inbound connection provisioning is in progress.
            • ACTIVE: Inbound connection is active and ready to use.
            • REJECTING: Inbound connection rejection is in process.
            • REJECTED: Inbound connection is rejected.
            • DELETING: Inbound connection deletion is in progress.
            • DELETED: Inbound connection is deleted and can no longer be used.
          • Message (string) --

            Verbose information for the inbound connection status.

    • NextToken (string) --

      If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Exceptions

describe_instance_type_limits(**kwargs)

Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the `` DomainName `` to see which limits you can modify.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance_type_limits(
    DomainName='string',
    InstanceType='m3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
    EngineVersion='string'
)
Parameters
  • DomainName (string) -- The name of the domain you want to modify. Only include this value if you're querying OpenSearch `` Limits `` for an existing domain.
  • InstanceType (string) --

    [REQUIRED]

    The instance type for an OpenSearch cluster for which OpenSearch `` Limits `` are needed.

  • EngineVersion (string) --

    [REQUIRED]

    Version of OpenSearch for which `` Limits `` are needed.

Return type

dict

Returns

Response Syntax

{
    'LimitsByRole': {
        'string': {
            'StorageTypes': [
                {
                    'StorageTypeName': 'string',
                    'StorageSubTypeName': 'string',
                    'StorageTypeLimits': [
                        {
                            'LimitName': 'string',
                            'LimitValues': [
                                'string',
                            ]
                        },
                    ]
                },
            ],
            'InstanceLimits': {
                'InstanceCountLimits': {
                    'MinimumInstanceCount': 123,
                    'MaximumInstanceCount': 123
                }
            },
            'AdditionalLimits': [
                {
                    'LimitName': 'string',
                    'LimitValues': [
                        'string',
                    ]
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    Container for the parameters received from the `` DescribeInstanceTypeLimits `` operation.

    • LimitsByRole (dict) --

      The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

      • data: If the given InstanceType is used as a data node
      • master: If the given InstanceType is used as a master node
      • ultra_warm: If the given InstanceType is used as a warm node
      • (string) --

        • (dict) --

          Limits for a given InstanceType and for each of its roles. Limits contains the following: `` StorageTypes `` , `` InstanceLimits `` , and `` AdditionalLimits ``

          • StorageTypes (list) --

            Storage-related types and attributes that are available for a given InstanceType.

            • (dict) --

              StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.

              • StorageTypeName (string) --

                Type of storage. List of available storage options:

                • instance

                Built-in storage available for the instance * ebs Elastic block storage attached to the instance

              • StorageSubTypeName (string) --

                Sub-type of the given storage type. List of available sub-storage options: "instance" storageType has no storageSubType. "ebs" storageType has the following valid storageSubTypes:

                • standard
                • gp2
                • io1

                See `` VolumeType `` for more information regarding each EBS storage option.

              • StorageTypeLimits (list) --

                Limits that are applicable for the given storage type.

                • (dict) --

                  Limits that are applicable for the given storage type.

                  • LimitName (string) --

                    Name of storage limits that are applicable for the given storage type. If `` StorageType `` is "ebs", the following storage options are applicable:

                    • MinimumVolumeSize

                    Minimum amount of volume size that is applicable for the given storage type. Can be empty if not applicable. * MaximumVolumeSize Maximum amount of volume size that is applicable for the given storage type. Can be empty if not applicable. * MaximumIops Maximum amount of Iops that is applicable for given the storage type. Can be empty if not applicable. * MinimumIops Minimum amount of Iops that is applicable for given the storage type. Can be empty if not applicable.

                  • LimitValues (list) --

                    Values for the `` StorageTypeLimit$LimitName `` .

                    • (string) --
          • InstanceLimits (dict) --

            InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.

            • InstanceCountLimits (dict) --

              InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.

              • MinimumInstanceCount (integer) --

                Minimum number of instances that can be instantiated for a given InstanceType.

              • MaximumInstanceCount (integer) --

                Maximum number of instances that can be instantiated for a given InstanceType.

          • AdditionalLimits (list) --

            List of additional limits that are specific to a given InstanceType and for each of its `` InstanceRole `` .

            • (dict) --

              List of limits that are specific to a given InstanceType and for each of its `` InstanceRole `` .

              • LimitName (string) --

                Additional limit is specific to a given InstanceType and for each of its `` InstanceRole `` etc. Attributes and their details:

                • MaximumNumberOfDataNodesSupported

                This attribute is present on the master node only to specify how much data nodes up to which given `` ESPartitionInstanceType `` can support as master node. * MaximumNumberOfDataNodesWithoutMasterNode This attribute is present on data node only to specify how much data nodes of given `` ESPartitionInstanceType `` up to which you don't need any master nodes to govern them.

              • LimitValues (list) --

                Value for a given `` AdditionalLimit$LimitName `` .

                • (string) --

Exceptions

describe_outbound_connections(**kwargs)

Lists all the outbound cross-cluster connections for a local domain.

See also: AWS API Documentation

Request Syntax

response = client.describe_outbound_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Filters (list) --

    A list of filters used to match properties for outbound cross-cluster connections. Available `` Filter `` names for this operation are:

    • connection-id
    • remote-domain-info.domain-name
    • remote-domain-info.owner-id
    • remote-domain-info.region
    • local-domain-info.domain-name
    • (dict) --

      A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

      • Name (string) --

        The name of the filter.

      • Values (list) --

        Contains one or more values for the filter.

        • (string) --
  • MaxResults (integer) -- Set this value to limit the number of results returned. If not specified, defaults to 100.
  • NextToken (string) -- NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.
Return type

dict

Returns

Response Syntax

{
    'Connections': [
        {
            'LocalDomainInfo': {
                'AWSDomainInformation': {
                    'OwnerId': 'string',
                    'DomainName': 'string',
                    'Region': 'string'
                }
            },
            'RemoteDomainInfo': {
                'AWSDomainInformation': {
                    'OwnerId': 'string',
                    'DomainName': 'string',
                    'Region': 'string'
                }
            },
            'ConnectionId': 'string',
            'ConnectionAlias': 'string',
            'ConnectionStatus': {
                'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The result of a `` DescribeOutboundConnections `` request. Contains the list of connections matching the filter criteria.

    • Connections (list) --

      A list of `` OutboundConnection `` matching the specified filter criteria.

      • (dict) --

        Specifies details about an outbound connection.

        • LocalDomainInfo (dict) --

          The `` DomainInformation `` for the local OpenSearch domain.

          • AWSDomainInformation (dict) --

            • OwnerId (string) --

            • DomainName (string) --

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region (string) --

        • RemoteDomainInfo (dict) --

          The `` DomainInformation `` for the remote OpenSearch domain.

          • AWSDomainInformation (dict) --

            • OwnerId (string) --

            • DomainName (string) --

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region (string) --

        • ConnectionId (string) --

          The connection ID for the outbound cross-cluster connection.

        • ConnectionAlias (string) --

          The connection alias for the outbound cross-cluster connection.

        • ConnectionStatus (dict) --

          The `` OutboundConnectionStatus `` for the outbound connection.

          • StatusCode (string) --

            The state code for the outbound connection. Can be one of the following:

            • VALIDATING: The outbound connection request is being validated.
            • VALIDATION_FAILED: Validation failed for the connection request.
            • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
            • APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.
            • PROVISIONING: Outbound connection request is in process.
            • ACTIVE: Outbound connection is active and ready to use.
            • REJECTING: Outbound connection rejection by remote domain owner is in progress.
            • REJECTED: Outbound connection request is rejected by remote domain owner.
            • DELETING: Outbound connection deletion is in progress.
            • DELETED: Outbound connection is deleted and can no longer be used.
          • Message (string) --

            Verbose information for the outbound connection status.

    • NextToken (string) --

      If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Exceptions

describe_packages(**kwargs)

Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

See also: AWS API Documentation

Request Syntax

response = client.describe_packages(
    Filters=[
        {
            'Name': 'PackageID'|'PackageName'|'PackageStatus',
            'Value': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Filters (list) --

    Only returns packages that match the DescribePackagesFilterList values.

    • (dict) --

      A filter to apply to the DescribePackage response.

      • Name (string) --

        Any field from PackageDetails .

      • Value (list) --

        A list of values for the specified field.

        • (string) --
  • MaxResults (integer) -- Limits results to a maximum number of packages.
  • NextToken (string) -- Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
Return type

dict

Returns

Response Syntax

{
    'PackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'PackageDescription': 'string',
            'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'AvailablePackageVersion': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for the response returned by the `` DescribePackages `` operation.

    • PackageDetailsList (list) --

      List of PackageDetails objects.

      • (dict) --

        Basic information about a package.

        • PackageID (string) --

          Internal ID of the package.

        • PackageName (string) --

          User-specified name of the package.

        • PackageType (string) --

          Currently supports only TXT-DICTIONARY.

        • PackageDescription (string) --

          User-specified description of the package.

        • PackageStatus (string) --

          Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

        • CreatedAt (datetime) --

          The timestamp of when the package was created.

        • LastUpdatedAt (datetime) --

        • AvailablePackageVersion (string) --

        • ErrorDetails (dict) --

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType (string) --
          • ErrorMessage (string) --
    • NextToken (string) --

Exceptions

describe_reserved_instance_offerings(**kwargs)

Lists available reserved OpenSearch instance offerings.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_instance_offerings(
    ReservedInstanceOfferingId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ReservedInstanceOfferingId (string) -- The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
  • MaxResults (integer) -- Set this value to limit the number of results returned. If not specified, defaults to 100.
  • NextToken (string) -- Provides an identifier to allow retrieval of paginated results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ReservedInstanceOfferings': [
        {
            'ReservedInstanceOfferingId': 'string',
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Container for results from DescribeReservedInstanceOfferings

    • NextToken (string) --

      Provides an identifier to allow retrieval of paginated results.

    • ReservedInstanceOfferings (list) --

      List of reserved OpenSearch instance offerings

      • (dict) --

        Details of a reserved OpenSearch instance offering.

        • ReservedInstanceOfferingId (string) --

          The OpenSearch reserved instance offering identifier.

        • InstanceType (string) --

          The OpenSearch instance type offered by the reserved instance offering.

        • Duration (integer) --

          The duration, in seconds, for which the offering will reserve the OpenSearch instance.

        • FixedPrice (float) --

          The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.

        • UsagePrice (float) --

          The rate you are charged for each hour the domain that is using the offering is running.

        • CurrencyCode (string) --

          The currency code for the reserved OpenSearch instance offering.

        • PaymentOption (string) --

          Payment option for the reserved OpenSearch instance offering

        • RecurringCharges (list) --

          The charge to your account regardless of whether you are creating any domains using the instance offering.

          • (dict) --

            Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.

            • RecurringChargeAmount (float) --

              The monetary amount of the recurring charge.

            • RecurringChargeFrequency (string) --

              The frequency of the recurring charge.

Exceptions

describe_reserved_instances(**kwargs)

Returns information about reserved OpenSearch instances for this account.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_instances(
    ReservedInstanceId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ReservedInstanceId (string) -- The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
  • MaxResults (integer) -- Set this value to limit the number of results returned. If not specified, defaults to 100.
  • NextToken (string) -- Provides an identifier to allow retrieval of paginated results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ReservedInstances': [
        {
            'ReservationName': 'string',
            'ReservedInstanceId': 'string',
            'BillingSubscriptionId': 123,
            'ReservedInstanceOfferingId': 'string',
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'StartTime': datetime(2015, 1, 1),
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'InstanceCount': 123,
            'State': 'string',
            'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Container for results from DescribeReservedInstances

    • NextToken (string) --

      Provides an identifier to allow retrieval of paginated results.

    • ReservedInstances (list) --

      List of reserved OpenSearch instances.

      • (dict) --

        Details of a reserved OpenSearch instance.

        • ReservationName (string) --

          The customer-specified identifier to track this reservation.

        • ReservedInstanceId (string) --

          The unique identifier for the reservation.

        • BillingSubscriptionId (integer) --

        • ReservedInstanceOfferingId (string) --

          The offering identifier.

        • InstanceType (string) --

          The OpenSearch instance type offered by the reserved instance offering.

        • StartTime (datetime) --

          The time the reservation started.

        • Duration (integer) --

          The duration, in seconds, for which the OpenSearch instance is reserved.

        • FixedPrice (float) --

          The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.

        • UsagePrice (float) --

          The rate you are charged for each hour for the domain that is using this reserved instance.

        • CurrencyCode (string) --

          The currency code for the reserved OpenSearch instance offering.

        • InstanceCount (integer) --

          The number of OpenSearch instances that have been reserved.

        • State (string) --

          The state of the reserved OpenSearch instance.

        • PaymentOption (string) --

          The payment option as defined in the reserved OpenSearch instance offering.

        • RecurringCharges (list) --

          The charge to your account regardless of whether you are creating any domains using the instance offering.

          • (dict) --

            Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.

            • RecurringChargeAmount (float) --

              The monetary amount of the recurring charge.

            • RecurringChargeFrequency (string) --

              The frequency of the recurring charge.

Exceptions

dissociate_package(**kwargs)

Dissociates a package from the Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

response = client.dissociate_package(
    PackageID='string',
    DomainName='string'
)
Parameters
  • PackageID (string) --

    [REQUIRED]

    The internal ID of the package to associate with a domain. Use DescribePackages to find this value.

  • DomainName (string) --

    [REQUIRED]

    The name of the domain to associate the package with.

Return type

dict

Returns

Response Syntax

{
    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
        'PackageVersion': 'string',
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for the response returned by `` DissociatePackage `` operation.

    • DomainPackageDetails (dict) --

      DomainPackageDetails

      • PackageID (string) --

        The internal ID of the package.

      • PackageName (string) --

        User-specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • LastUpdated (datetime) --

        The timestamp of the most recent update to the package association status.

      • DomainName (string) --

        The name of the domain you've associated a package with.

      • DomainPackageStatus (string) --

        State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

      • PackageVersion (string) --

      • ReferencePath (string) --

        The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

      • ErrorDetails (dict) --

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) --
        • ErrorMessage (string) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_compatible_versions(**kwargs)

Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a `` DomainName `` to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.

See also: AWS API Documentation

Request Syntax

response = client.get_compatible_versions(
    DomainName='string'
)
Parameters
DomainName (string) -- The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Return type
dict
Returns
Response Syntax
{
    'CompatibleVersions': [
        {
            'SourceVersion': 'string',
            'TargetVersions': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Container for the response returned by the `` GetCompatibleVersions `` operation.

    • CompatibleVersions (list) --

      A map of compatible OpenSearch versions returned as part of the `` GetCompatibleVersions `` operation.

      • (dict) --

        A map from an `` EngineVersion `` to a list of compatible `` EngineVersion `` s to which the domain can be upgraded.

        • SourceVersion (string) --

          The current version of OpenSearch a domain is on.

        • TargetVersions (list) --

          List of supported OpenSearch versions.

          • (string) --

Exceptions

get_package_version_history(**kwargs)

Returns a list of package versions, along with their creation time and commit message.

See also: AWS API Documentation

Request Syntax

response = client.get_package_version_history(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • PackageID (string) --

    [REQUIRED]

    Returns an audit history of package versions.

  • MaxResults (integer) -- Limits results to a maximum number of package versions.
  • NextToken (string) -- Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
Return type

dict

Returns

Response Syntax

{
    'PackageID': 'string',
    'PackageVersionHistoryList': [
        {
            'PackageVersion': 'string',
            'CommitMessage': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for response returned by `` GetPackageVersionHistory `` operation.

    • PackageID (string) --

    • PackageVersionHistoryList (list) --

      List of PackageVersionHistory objects.

      • (dict) --

        Details of a package version.

        • PackageVersion (string) --

          The package version.

        • CommitMessage (string) --

          A message associated with the package version.

        • CreatedAt (datetime) --

          The timestamp of when the package was created.

    • NextToken (string) --

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_upgrade_history(**kwargs)

Retrieves the complete history of the last 10 upgrades performed on the domain.

See also: AWS API Documentation

Request Syntax

response = client.get_upgrade_history(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • MaxResults (integer) -- Set this value to limit the number of results returned.
  • NextToken (string) -- Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.
Return type

dict

Returns

Response Syntax

{
    'UpgradeHistories': [
        {
            'UpgradeName': 'string',
            'StartTimestamp': datetime(2015, 1, 1),
            'UpgradeStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
            'StepsList': [
                {
                    'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
                    'UpgradeStepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
                    'Issues': [
                        'string',
                    ],
                    'ProgressPercent': 123.0
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for the response returned by the `` GetUpgradeHistory `` operation.

    • UpgradeHistories (list) --

      A list of `` UpgradeHistory `` objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the `` GetUpgradeHistoryResponse `` object.

      • (dict) --

        History of the last 10 upgrades and upgrade eligibility checks.

        • UpgradeName (string) --

          A string that briefly describes the upgrade.

        • StartTimestamp (datetime) --

          UTC timestamp at which the upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

        • UpgradeStatus (string) --

          The current status of the upgrade. The status can take one of the following values:

          • In Progress
          • Succeeded
          • Succeeded with Issues
          • Failed
        • StepsList (list) --

          A list of `` UpgradeStepItem `` s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.

          • (dict) --

            Represents a single step of the upgrade or upgrade eligibility check workflow.

            • UpgradeStep (string) --

              One of three steps an upgrade or upgrade eligibility check goes through:

              • PreUpgradeCheck
              • Snapshot
              • Upgrade
            • UpgradeStepStatus (string) --

              The current status of the upgrade. The status can take one of the following values:

              • In Progress
              • Succeeded
              • Succeeded with Issues
              • Failed
            • Issues (list) --

              A list of strings containing detailed information about the errors encountered in a particular step.

              • (string) --
            • ProgressPercent (float) --

              The floating point value representing the progress percentage of a particular step.

    • NextToken (string) --

      Pagination token that needs to be supplied to the next call to get the next page of results.

Exceptions

get_upgrade_status(**kwargs)

Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.

See also: AWS API Documentation

Request Syntax

response = client.get_upgrade_status(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type
dict
Returns
Response Syntax
{
    'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
    'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
    'UpgradeName': 'string'
}

Response Structure

  • (dict) --

    Container for the response returned by the `` GetUpgradeStatus `` operation.

    • UpgradeStep (string) --

      One of three steps an upgrade or upgrade eligibility check goes through:

      • PreUpgradeCheck
      • Snapshot
      • Upgrade
    • StepStatus (string) --

      One of four statuses an upgrade have, returned as part of the `` GetUpgradeStatusResponse `` object. The status can take one of the following values:

      • In Progress
      • Succeeded
      • Succeeded with Issues
      • Failed
    • UpgradeName (string) --

      A string that briefly describes the update.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_domain_names(**kwargs)

Returns the names of all domains owned by the current user's account.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_names(
    EngineType='OpenSearch'|'Elasticsearch'
)
Parameters
EngineType (string) -- Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
Return type
dict
Returns
Response Syntax
{
    'DomainNames': [
        {
            'DomainName': 'string',
            'EngineType': 'OpenSearch'|'Elasticsearch'
        },
    ]
}

Response Structure

  • (dict) --

    The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

    • DomainNames (list) --

      List of domain names and respective engine types.

      • (dict) --
        • DomainName (string) --

          The DomainName .

        • EngineType (string) --

          Specifies the EngineType of the domain.

Exceptions

list_domains_for_package(**kwargs)

Lists all Amazon OpenSearch Service domains associated with the package.

See also: AWS API Documentation

Request Syntax

response = client.list_domains_for_package(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • PackageID (string) --

    [REQUIRED]

    The package for which to list associated domains.

  • MaxResults (integer) -- Limits the results to a maximum number of domains.
  • NextToken (string) -- Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
Return type

dict

Returns

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for the response parameters to the `` ListDomainsForPackage `` operation.

    • DomainPackageDetailsList (list) --

      List of DomainPackageDetails objects.

      • (dict) --

        Information on a package associated with a domain.

        • PackageID (string) --

          The internal ID of the package.

        • PackageName (string) --

          User-specified name of the package.

        • PackageType (string) --

          Currently supports only TXT-DICTIONARY.

        • LastUpdated (datetime) --

          The timestamp of the most recent update to the package association status.

        • DomainName (string) --

          The name of the domain you've associated a package with.

        • DomainPackageStatus (string) --

          State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

        • PackageVersion (string) --

        • ReferencePath (string) --

          The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

        • ErrorDetails (dict) --

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType (string) --
          • ErrorMessage (string) --
    • NextToken (string) --

Exceptions

list_instance_type_details(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_instance_type_details(
    EngineVersion='string',
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • EngineVersion (string) -- [REQUIRED]
  • DomainName (string) -- The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  • MaxResults (integer) -- Set this value to limit the number of results returned.
  • NextToken (string) -- Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.
Return type

dict

Returns

Response Syntax

{
    'InstanceTypeDetails': [
        {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'EncryptionEnabled': True|False,
            'CognitoEnabled': True|False,
            'AppLogsEnabled': True|False,
            'AdvancedSecurityEnabled': True|False,
            'WarmEnabled': True|False,
            'InstanceRole': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstanceTypeDetails (list) --

      • (dict) --
        • InstanceType (string) --
        • EncryptionEnabled (boolean) --
        • CognitoEnabled (boolean) --
        • AppLogsEnabled (boolean) --
        • AdvancedSecurityEnabled (boolean) --
        • WarmEnabled (boolean) --
        • InstanceRole (list) --
          • (string) --
    • NextToken (string) --

      Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Exceptions

list_packages_for_domain(**kwargs)

Lists all packages associated with the Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

response = client.list_packages_for_domain(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The name of the domain for which you want to list associated packages.

  • MaxResults (integer) -- Limits results to a maximum number of packages.
  • NextToken (string) -- Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
Return type

dict

Returns

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for the response parameters to the `` ListPackagesForDomain `` operation.

    • DomainPackageDetailsList (list) --

      List of DomainPackageDetails objects.

      • (dict) --

        Information on a package associated with a domain.

        • PackageID (string) --

          The internal ID of the package.

        • PackageName (string) --

          User-specified name of the package.

        • PackageType (string) --

          Currently supports only TXT-DICTIONARY.

        • LastUpdated (datetime) --

          The timestamp of the most recent update to the package association status.

        • DomainName (string) --

          The name of the domain you've associated a package with.

        • DomainPackageStatus (string) --

          State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

        • PackageVersion (string) --

        • ReferencePath (string) --

          The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

        • ErrorDetails (dict) --

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType (string) --
          • ErrorMessage (string) --
    • NextToken (string) --

      Pagination token to supply to the next call to get the next page of results.

Exceptions

list_tags(**kwargs)

Returns all tags for the given domain.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    ARN='string'
)
Parameters
ARN (string) --

[REQUIRED]

Specify the ARN of the domain that the tags you want to view are attached to.

Return type
dict
Returns
Response Syntax
{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The result of a ListTags operation. Contains tags for all requested domains.

    • TagList (list) --

      List of Tag for the requested domain.

      • (dict) --

        A key value pair for a resource tag.

        • Key (string) --

          The TagKey , the name of the tag. Tag keys must be unique for the domain to which they are attached.

        • Value (string) --

          The TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Exceptions

list_versions(**kwargs)

List all supported versions of OpenSearch and Elasticsearch.

See also: AWS API Documentation

Request Syntax

response = client.list_versions(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.
  • NextToken (string) -- Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.
Return type

dict

Returns

Response Syntax

{
    'Versions': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for the parameters for response received from the `` ListVersions `` operation.

    • Versions (list) --

      List of supported OpenSearch versions.

      • (string) --
    • NextToken (string) --

      Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Exceptions

purchase_reserved_instance_offering(**kwargs)

Allows you to purchase reserved OpenSearch instances.

See also: AWS API Documentation

Request Syntax

response = client.purchase_reserved_instance_offering(
    ReservedInstanceOfferingId='string',
    ReservationName='string',
    InstanceCount=123
)
Parameters
  • ReservedInstanceOfferingId (string) --

    [REQUIRED]

    The ID of the reserved OpenSearch instance offering to purchase.

  • ReservationName (string) --

    [REQUIRED]

    A customer-specified identifier to track this reservation.

  • InstanceCount (integer) -- The number of OpenSearch instances to reserve.
Return type

dict

Returns

Response Syntax

{
    'ReservedInstanceId': 'string',
    'ReservationName': 'string'
}

Response Structure

  • (dict) --

    Represents the output of a PurchaseReservedInstanceOffering operation.

    • ReservedInstanceId (string) --

      Details of the reserved OpenSearch instance which was purchased.

    • ReservationName (string) --

      The customer-specified identifier used to track this reservation.

Exceptions

reject_inbound_connection(**kwargs)

Allows the remote domain owner to reject an inbound cross-cluster connection request.

See also: AWS API Documentation

Request Syntax

response = client.reject_inbound_connection(
    ConnectionId='string'
)
Parameters
ConnectionId (string) --

[REQUIRED]

The ID of the inbound connection to reject.

Return type
dict
Returns
Response Syntax
{
    'Connection': {
        'LocalDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'RemoteDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'ConnectionId': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result of a `` RejectInboundConnection `` operation. Contains details about the rejected inbound connection.

    • Connection (dict) --

      The `` InboundConnection `` of the rejected inbound connection.

      • LocalDomainInfo (dict) --

        The `` AWSDomainInformation `` for the local OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • RemoteDomainInfo (dict) --

        The `` AWSDomainInformation `` for the remote OpenSearch domain.

        • AWSDomainInformation (dict) --
          • OwnerId (string) --
          • DomainName (string) --

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region (string) --
      • ConnectionId (string) --

        The connection ID for the inbound cross-cluster connection.

      • ConnectionStatus (dict) --

        The `` InboundConnectionStatus `` for the outbound connection.

        • StatusCode (string) --

          The state code for the inbound connection. Can be one of the following:

          • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.
          • APPROVED: Inbound connection is pending acceptance by the remote domain owner.
          • PROVISIONING: Inbound connection provisioning is in progress.
          • ACTIVE: Inbound connection is active and ready to use.
          • REJECTING: Inbound connection rejection is in process.
          • REJECTED: Inbound connection is rejected.
          • DELETING: Inbound connection deletion is in progress.
          • DELETED: Inbound connection is deleted and can no longer be used.
        • Message (string) --

          Verbose information for the inbound connection status.

Exceptions

remove_tags(**kwargs)

Removes the specified set of tags from the given domain.

See also: AWS API Documentation

Request Syntax

response = client.remove_tags(
    ARN='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ARN (string) --

    [REQUIRED]

    The ARN of the domain from which you want to delete the specified tags.

  • TagKeys (list) --

    [REQUIRED]

    The TagKey list you want to remove from the domain.

    • (string) --
Returns

None

Exceptions

start_service_software_update(**kwargs)

Schedules a service software update for an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

response = client.start_service_software_update(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The name of the domain that you want to update to the latest service software.

Return type
dict
Returns
Response Syntax
{
    'ServiceSoftwareOptions': {
        'CurrentVersion': 'string',
        'NewVersion': 'string',
        'UpdateAvailable': True|False,
        'Cancellable': True|False,
        'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
        'Description': 'string',
        'AutomatedUpdateDate': datetime(2015, 1, 1),
        'OptionalDeployment': True|False
    }
}

Response Structure

  • (dict) --

    The result of a StartServiceSoftwareUpdate operation. Contains the status of the update.

    • ServiceSoftwareOptions (dict) --

      The current status of the OpenSearch service software update.

      • CurrentVersion (string) --

        The current service software version present on the domain.

      • NewVersion (string) --

        The new service software version if one is available.

      • UpdateAvailable (boolean) --
        True if you're able to update your service software version. False if you can't update your service software version.
      • Cancellable (boolean) --
        True if you're able to cancel your service software version update. False if you can't cancel your service software update.
      • UpdateStatus (string) --

        The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .

      • Description (string) --

        The description of the UpdateStatus .

      • AutomatedUpdateDate (datetime) --

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) --
        True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .

Exceptions

update_domain_config(**kwargs)

Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_config(
    DomainName='string',
    ClusterConfig={
        'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'InstanceCount': 123,
        'DedicatedMasterEnabled': True|False,
        'ZoneAwarenessEnabled': True|False,
        'ZoneAwarenessConfig': {
            'AvailabilityZoneCount': 123
        },
        'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'DedicatedMasterCount': 123,
        'WarmEnabled': True|False,
        'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
        'WarmCount': 123,
        'ColdStorageOptions': {
            'Enabled': True|False
        }
    },
    EBSOptions={
        'EBSEnabled': True|False,
        'VolumeType': 'standard'|'gp2'|'io1',
        'VolumeSize': 123,
        'Iops': 123
    },
    SnapshotOptions={
        'AutomatedSnapshotStartHour': 123
    },
    VPCOptions={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    CognitoOptions={
        'Enabled': True|False,
        'UserPoolId': 'string',
        'IdentityPoolId': 'string',
        'RoleArn': 'string'
    },
    AdvancedOptions={
        'string': 'string'
    },
    AccessPolicies='string',
    LogPublishingOptions={
        'string': {
            'CloudWatchLogsLogGroupArn': 'string',
            'Enabled': True|False
        }
    },
    EncryptionAtRestOptions={
        'Enabled': True|False,
        'KmsKeyId': 'string'
    },
    DomainEndpointOptions={
        'EnforceHTTPS': True|False,
        'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
        'CustomEndpointEnabled': True|False,
        'CustomEndpoint': 'string',
        'CustomEndpointCertificateArn': 'string'
    },
    NodeToNodeEncryptionOptions={
        'Enabled': True|False
    },
    AdvancedSecurityOptions={
        'Enabled': True|False,
        'InternalUserDatabaseEnabled': True|False,
        'MasterUserOptions': {
            'MasterUserARN': 'string',
            'MasterUserName': 'string',
            'MasterUserPassword': 'string'
        },
        'SAMLOptions': {
            'Enabled': True|False,
            'Idp': {
                'MetadataContent': 'string',
                'EntityId': 'string'
            },
            'MasterUserName': 'string',
            'MasterBackendRole': 'string',
            'SubjectKey': 'string',
            'RolesKey': 'string',
            'SessionTimeoutMinutes': 123
        }
    },
    AutoTuneOptions={
        'DesiredState': 'ENABLED'|'DISABLED',
        'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
        'MaintenanceSchedules': [
            {
                'StartAt': datetime(2015, 1, 1),
                'Duration': {
                    'Value': 123,
                    'Unit': 'HOURS'
                },
                'CronExpressionForRecurrence': 'string'
            },
        ]
    }
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The name of the domain you're updating.

  • ClusterConfig (dict) --

    The type and number of instances to instantiate for the domain cluster.

    • InstanceType (string) --

      The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

    • InstanceCount (integer) --

      The number of instances in the specified domain cluster.

    • DedicatedMasterEnabled (boolean) --

      A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

    • ZoneAwarenessEnabled (boolean) --

      A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

    • ZoneAwarenessConfig (dict) --

      The zone awareness configuration for a domain when zone awareness is enabled.

      • AvailabilityZoneCount (integer) --

        An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

    • DedicatedMasterType (string) --

      The instance type for a dedicated master node.

    • DedicatedMasterCount (integer) --

      Total number of dedicated master nodes, active and on standby, for the cluster.

    • WarmEnabled (boolean) --

      True to enable UltraWarm storage.

    • WarmType (string) --

      The instance type for the OpenSearch cluster's warm nodes.

    • WarmCount (integer) --

      The number of UltraWarm nodes in the cluster.

    • ColdStorageOptions (dict) --

      Specifies the ColdStorageOptions config for a Domain

      • Enabled (boolean) -- [REQUIRED]

        Enable cold storage option. Accepted values true or false

  • EBSOptions (dict) --

    Specify the type and size of the EBS volume to use.

    • EBSEnabled (boolean) --

      Whether EBS-based storage is enabled.

    • VolumeType (string) --

      The volume type for EBS-based storage.

    • VolumeSize (integer) --

      Integer to specify the size of an EBS volume.

    • Iops (integer) --

      The IOPD for a Provisioned IOPS EBS volume (SSD).

  • SnapshotOptions (dict) --

    Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

    • AutomatedSnapshotStartHour (integer) --

      The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

  • VPCOptions (dict) --

    Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

    • SubnetIds (list) --

      The subnets for the VPC endpoint.

      • (string) --
    • SecurityGroupIds (list) --

      The security groups for the VPC endpoint.

      • (string) --
  • CognitoOptions (dict) --

    Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

    • Enabled (boolean) --

      The option to enable Cognito for OpenSearch Dashboards authentication.

    • UserPoolId (string) --

      The Cognito user pool ID for OpenSearch Dashboards authentication.

    • IdentityPoolId (string) --

      The Cognito identity pool ID for OpenSearch Dashboards authentication.

    • RoleArn (string) --

      The role ARN that provides OpenSearch permissions for accessing Cognito resources.

  • AdvancedOptions (dict) --

    Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced options for more information.

    • (string) --
      • (string) --
  • AccessPolicies (string) -- IAM access policy as a JSON-formatted string.
  • LogPublishingOptions (dict) --

    Map of LogType and LogPublishingOption , each containing options to publish a given type of OpenSearch log.

    • (string) --

      Type of log file. Can be one of the following:

      • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
      • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
      • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
      • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
      • (dict) --

        Log Publishing option that is set for a given domain. Attributes and their details:

        • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
        • Enabled: Whether the log publishing for a given log type is enabled or not.
        • CloudWatchLogsLogGroupArn (string) --

          ARN of the Cloudwatch log group to publish logs to.

        • Enabled (boolean) --

          Whether the given log publishing option is enabled or not.

  • EncryptionAtRestOptions (dict) --

    Specifies encryption of data at rest options.

    • Enabled (boolean) --

      The option to enable encryption at rest.

    • KmsKeyId (string) --

      The KMS key ID for encryption at rest options.

  • DomainEndpointOptions (dict) --

    Options to specify configuration that will be applied to the domain endpoint.

    • EnforceHTTPS (boolean) --

      Whether only HTTPS endpoint should be enabled for the domain.

    • TLSSecurityPolicy (string) --

      Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

      • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
      • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
    • CustomEndpointEnabled (boolean) --

      Whether to enable a custom endpoint for the domain.

    • CustomEndpoint (string) --

      The fully qualified domain for your custom endpoint.

    • CustomEndpointCertificateArn (string) --

      The ACM certificate ARN for your custom endpoint.

  • NodeToNodeEncryptionOptions (dict) --

    Specifies node-to-node encryption options.

    • Enabled (boolean) --

      True to enable node-to-node encryption.

  • AdvancedSecurityOptions (dict) --

    Specifies advanced security options.

    • Enabled (boolean) --

      True if advanced security is enabled.

    • InternalUserDatabaseEnabled (boolean) --

      True if the internal user database is enabled.

    • MasterUserOptions (dict) --

      Credentials for the master user: username and password, ARN, or both.

      • MasterUserARN (string) --

        ARN for the master user (if IAM is enabled).

      • MasterUserName (string) --

        The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.

      • MasterUserPassword (string) --

        The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.

    • SAMLOptions (dict) --

      The SAML application configuration for the domain.

      • Enabled (boolean) --

        True if SAML is enabled.

      • Idp (dict) --

        The SAML Identity Provider's information.

        • MetadataContent (string) -- [REQUIRED]

          The metadata of the SAML application in XML format.

        • EntityId (string) -- [REQUIRED]

          The unique entity ID of the application in SAML identity provider.

      • MasterUserName (string) --

        The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

      • MasterBackendRole (string) --

        The backend role that the SAML master user is mapped to.

      • SubjectKey (string) --

        Element of the SAML assertion to use for username. Default is NameID.

      • RolesKey (string) --

        Element of the SAML assertion to use for backend roles. Default is roles.

      • SessionTimeoutMinutes (integer) --

        The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

  • AutoTuneOptions (dict) --

    Specifies Auto-Tune options.

    • DesiredState (string) --

      The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

    • RollbackOnDisable (string) --

      The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

    • MaintenanceSchedules (list) --

      A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

Return type

dict

Returns

Response Syntax

{
    'DomainConfig': {
        'EngineVersion': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'ClusterConfig': {
            'Options': {
                'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'InstanceCount': 123,
                'DedicatedMasterEnabled': True|False,
                'ZoneAwarenessEnabled': True|False,
                'ZoneAwarenessConfig': {
                    'AvailabilityZoneCount': 123
                },
                'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'DedicatedMasterCount': 123,
                'WarmEnabled': True|False,
                'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
                'WarmCount': 123,
                'ColdStorageOptions': {
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EBSOptions': {
            'Options': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1',
                'VolumeSize': 123,
                'Iops': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AccessPolicies': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'SnapshotOptions': {
            'Options': {
                'AutomatedSnapshotStartHour': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'VPCOptions': {
            'Options': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'CognitoOptions': {
            'Options': {
                'Enabled': True|False,
                'UserPoolId': 'string',
                'IdentityPoolId': 'string',
                'RoleArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EncryptionAtRestOptions': {
            'Options': {
                'Enabled': True|False,
                'KmsKeyId': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'NodeToNodeEncryptionOptions': {
            'Options': {
                'Enabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedOptions': {
            'Options': {
                'string': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'LogPublishingOptions': {
            'Options': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'DomainEndpointOptions': {
            'Options': {
                'EnforceHTTPS': True|False,
                'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
                'CustomEndpointEnabled': True|False,
                'CustomEndpoint': 'string',
                'CustomEndpointCertificateArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedSecurityOptions': {
            'Options': {
                'Enabled': True|False,
                'InternalUserDatabaseEnabled': True|False,
                'SAMLOptions': {
                    'Enabled': True|False,
                    'Idp': {
                        'MetadataContent': 'string',
                        'EntityId': 'string'
                    },
                    'SubjectKey': 'string',
                    'RolesKey': 'string',
                    'SessionTimeoutMinutes': 123
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AutoTuneOptions': {
            'Options': {
                'DesiredState': 'ENABLED'|'DISABLED',
                'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
                'MaintenanceSchedules': [
                    {
                        'StartAt': datetime(2015, 1, 1),
                        'Duration': {
                            'Value': 123,
                            'Unit': 'HOURS'
                        },
                        'CronExpressionForRecurrence': 'string'
                    },
                ]
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
                'ErrorMessage': 'string',
                'PendingDeletion': True|False
            }
        }
    }
}

Response Structure

  • (dict) --

    The result of an UpdateDomain request. Contains the status of the domain being updated.

    • DomainConfig (dict) --

      The status of the updated domain.

      • EngineVersion (dict) --

        String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

        • Options (string) --

          The OpenSearch version for the specified OpenSearch domain.

        • Status (dict) --

          The status of the OpenSearch version options for the specified OpenSearch domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • ClusterConfig (dict) --

        The ClusterConfig for the domain.

        • Options (dict) --

          The cluster configuration for the specified domain.

          • InstanceType (string) --

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

          • InstanceCount (integer) --

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled (boolean) --

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled (boolean) --

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig (dict) --

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount (integer) --

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType (string) --

            The instance type for a dedicated master node.

          • DedicatedMasterCount (integer) --

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled (boolean) --

            True to enable UltraWarm storage.

          • WarmType (string) --

            The instance type for the OpenSearch cluster's warm nodes.

          • WarmCount (integer) --

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions (dict) --

            Specifies the ColdStorageOptions config for a Domain

            • Enabled (boolean) --

              Enable cold storage option. Accepted values true or false

        • Status (dict) --

          The cluster configuration status for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • EBSOptions (dict) --

        The EBSOptions for the domain.

        • Options (dict) --

          The EBS options for the specified domain.

          • EBSEnabled (boolean) --

            Whether EBS-based storage is enabled.

          • VolumeType (string) --

            The volume type for EBS-based storage.

          • VolumeSize (integer) --

            Integer to specify the size of an EBS volume.

          • Iops (integer) --

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • Status (dict) --

          The status of the EBS options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AccessPolicies (dict) --

        IAM access policy as a JSON-formatted string.

        • Options (string) --

          The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policies for more information.

        • Status (dict) --

          The status of the access policy for the domain. See OptionStatus for the status information that's included.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • SnapshotOptions (dict) --

        The SnapshotOptions for the domain.

        • Options (dict) --

          The daily snapshot options specified for the domain.

          • AutomatedSnapshotStartHour (integer) --

            The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • Status (dict) --

          The status of a daily automated snapshot.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • VPCOptions (dict) --

        The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

        • Options (dict) --

          The VPC options for the specified domain.

          • VPCId (string) --

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions .

          • SubnetIds (list) --

            The subnets for the VPC endpoint.

            • (string) --
          • AvailabilityZones (list) --

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .

            • (string) --
          • SecurityGroupIds (list) --

            The security groups for the VPC endpoint.

            • (string) --
        • Status (dict) --

          The status of the VPC options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • CognitoOptions (dict) --

        The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

        • Options (dict) --

          Cognito options for the specified domain.

          • Enabled (boolean) --

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId (string) --

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId (string) --

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn (string) --

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • Status (dict) --

          The status of the Cognito options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • EncryptionAtRestOptions (dict) --

        The EncryptionAtRestOptions for the domain.

        • Options (dict) --

          The Encryption At Rest options for the specified domain.

          • Enabled (boolean) --

            The option to enable encryption at rest.

          • KmsKeyId (string) --

            The KMS key ID for encryption at rest options.

        • Status (dict) --

          The status of the Encryption At Rest options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • NodeToNodeEncryptionOptions (dict) --

        The NodeToNodeEncryptionOptions for the domain.

        • Options (dict) --

          The node-to-node encryption options for the specified domain.

          • Enabled (boolean) --

            True to enable node-to-node encryption.

        • Status (dict) --

          The status of the node-to-node encryption options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AdvancedOptions (dict) --

        The AdvancedOptions for the domain. See Advanced options for more information.

        • Options (dict) --

          The status of advanced options for the specified domain.

          • (string) --
            • (string) --
        • Status (dict) --

          The OptionStatus for advanced options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • LogPublishingOptions (dict) --

        Log publishing options for the given domain.

        • Options (dict) --

          The log publishing options configured for the domain.

          • (string) --

            Type of log file. Can be one of the following:

            • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
            • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
            • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
            • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
            • (dict) --

              Log Publishing option that is set for a given domain. Attributes and their details:

              • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
              • Enabled: Whether the log publishing for a given log type is enabled or not.
              • CloudWatchLogsLogGroupArn (string) --

                ARN of the Cloudwatch log group to publish logs to.

              • Enabled (boolean) --

                Whether the given log publishing option is enabled or not.

        • Status (dict) --

          The status of the log publishing options for the domain. See OptionStatus for the status information that's included.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • DomainEndpointOptions (dict) --

        The DomainEndpointOptions for the domain.

        • Options (dict) --

          Options to configure the endpoint for the domain.

          • EnforceHTTPS (boolean) --

            Whether only HTTPS endpoint should be enabled for the domain.

          • TLSSecurityPolicy (string) --

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
          • CustomEndpointEnabled (boolean) --

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint (string) --

            The fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn (string) --

            The ACM certificate ARN for your custom endpoint.

        • Status (dict) --

          The status of the endpoint options for the domain. See OptionStatus for the status information that's included.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AdvancedSecurityOptions (dict) --

        Specifies AdvancedSecurityOptions for the domain.

        • Options (dict) --

          Advanced security options for the specified domain.

          • Enabled (boolean) --

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled (boolean) --

            True if the internal user database is enabled.

          • SAMLOptions (dict) --

            Describes the SAML application configured for a domain.

            • Enabled (boolean) --

              True if SAML is enabled.

            • Idp (dict) --

              Describes the SAML identity provider's information.

              • MetadataContent (string) --

                The metadata of the SAML application in XML format.

              • EntityId (string) --

                The unique entity ID of the application in SAML identity provider.

            • SubjectKey (string) --

              The key used for matching the SAML subject attribute.

            • RolesKey (string) --

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes (integer) --

              The duration, in minutes, after which a user session becomes inactive.

        • Status (dict) --

          Status of the advanced security options for the specified domain.

          • CreationDate (datetime) --

            The timestamp of when the entity was created.

          • UpdateDate (datetime) --

            The timestamp of the last time the entity was updated.

          • UpdateVersion (integer) --

            The latest version of the entity.

          • State (string) --

            Provides the OptionState for the domain.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

      • AutoTuneOptions (dict) --

        Specifies AutoTuneOptions for the domain.

        • Options (dict) --

          Specifies Auto-Tune options for the domain.

          • DesiredState (string) --

            The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

          • RollbackOnDisable (string) --

            The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

          • MaintenanceSchedules (list) --

            A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

        • Status (dict) --

          The status of the Auto-Tune options for the domain.

          • CreationDate (datetime) --

            The timestamp of the Auto-Tune options creation date.

          • UpdateDate (datetime) --

            The timestamp of when the Auto-Tune options were last updated.

          • UpdateVersion (integer) --

            The latest version of the Auto-Tune options.

          • State (string) --

            The AutoTuneState for the domain.

          • ErrorMessage (string) --

            The error message while enabling or disabling Auto-Tune.

          • PendingDeletion (boolean) --

            Indicates whether the domain is being deleted.

Exceptions

update_package(**kwargs)

Updates a package for use with Amazon OpenSearch Service domains.

See also: AWS API Documentation

Request Syntax

response = client.update_package(
    PackageID='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    },
    PackageDescription='string',
    CommitMessage='string'
)
Parameters
  • PackageID (string) --

    [REQUIRED]

    The unique identifier for the package.

  • PackageSource (dict) --

    [REQUIRED]

    The Amazon S3 location for importing the package specified as S3BucketName and S3Key

    • S3BucketName (string) --

      The name of the Amazon S3 bucket containing the package.

    • S3Key (string) --

      Key (file name) of the package.

  • PackageDescription (string) -- A new description of the package.
  • CommitMessage (string) -- A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse .
Return type

dict

Returns

Response Syntax

{
    'PackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'PackageDescription': 'string',
        'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'AvailablePackageVersion': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for the response returned by the `` UpdatePackage `` operation.

    • PackageDetails (dict) --

      Information about the package.

      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User-specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • PackageDescription (string) --

        User-specified description of the package.

      • PackageStatus (string) --

        Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

      • CreatedAt (datetime) --

        The timestamp of when the package was created.

      • LastUpdatedAt (datetime) --

      • AvailablePackageVersion (string) --

      • ErrorDetails (dict) --

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) --
        • ErrorMessage (string) --

Exceptions

upgrade_domain(**kwargs)

Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_domain(
    DomainName='string',
    TargetVersion='string',
    PerformCheckOnly=True|False,
    AdvancedOptions={
        'string': 'string'
    }
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • TargetVersion (string) --

    [REQUIRED]

    The version of OpenSearch you intend to upgrade the domain to.

  • PerformCheckOnly (boolean) -- When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
  • AdvancedOptions (dict) --

    Exposes select native OpenSearch configuration values from opensearch.yml . Currently, the following advanced options are available:

    • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced cluster parameters for more information.
    • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

    For more information, see Advanced cluster parameters .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'UpgradeId': 'string',
    'DomainName': 'string',
    'TargetVersion': 'string',
    'PerformCheckOnly': True|False,
    'AdvancedOptions': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Container for response returned by `` UpgradeDomain `` operation.

    • UpgradeId (string) --

    • DomainName (string) --

      The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • TargetVersion (string) --

      The version of OpenSearch that you intend to upgrade the domain to.

    • PerformCheckOnly (boolean) --

      When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

    • AdvancedOptions (dict) --

      Exposes select native OpenSearch configuration values from opensearch.yml . Currently, the following advanced options are available:

      • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced cluster parameters for more information.
      • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

      For more information, see Advanced cluster parameters .

      • (string) --
        • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class OpenSearchService.Client.exceptions.AccessDeniedException

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.BaseException

An error occurred while processing the request.

Example

try:
  ...
except client.exceptions.BaseException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An error occurred while processing the request.

    • message (string) --

      A description of the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.ConflictException

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.DisabledOperationException

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

Example

try:
  ...
except client.exceptions.DisabledOperationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.InternalException

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

Example

try:
  ...
except client.exceptions.InternalException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.InvalidPaginationTokenException

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

Example

try:
  ...
except client.exceptions.InvalidPaginationTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.InvalidTypeException

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

Example

try:
  ...
except client.exceptions.InvalidTypeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.LimitExceededException

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.ResourceAlreadyExistsException

An exception for creating a resource that already exists. Gives http status code of 400.

Example

try:
  ...
except client.exceptions.ResourceAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An exception for creating a resource that already exists. Gives http status code of 400.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.ResourceNotFoundException

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class OpenSearchService.Client.exceptions.ValidationException

An exception for missing / invalid input fields. Gives http status code of 400.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An exception for missing / invalid input fields. Gives http status code of 400.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: