{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.opensearch#AIConfig": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Configuration settings for AI-powered capabilities of an OpenSearch UI application.

" } }, "com.amazonaws.opensearch#AIMLOptionsInput": { "type": "structure", "members": { "NaturalLanguageQueryGenerationOptions": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput", "traits": { "smithy.api#documentation": "

Container for parameters required for natural language query generation on the\n specified domain.

" } }, "S3VectorsEngine": { "target": "com.amazonaws.opensearch#S3VectorsEngine", "traits": { "smithy.api#documentation": "

Container for parameters required to enable S3 vectors engine features on the\n specified domain.

" } }, "ServerlessVectorAcceleration": { "target": "com.amazonaws.opensearch#ServerlessVectorAcceleration", "traits": { "smithy.api#documentation": "

Specifies whether to enable serverless vector acceleration for the domain. When enabled,\n provides GPU-accelerated vector search capabilities for improved performance on vector\n workloads.

" } } }, "traits": { "smithy.api#documentation": "

Container for parameters required to enable all machine learning features.

" } }, "com.amazonaws.opensearch#AIMLOptionsOutput": { "type": "structure", "members": { "NaturalLanguageQueryGenerationOptions": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput", "traits": { "smithy.api#documentation": "

Container for parameters required for natural language query generation on the\n specified domain.

" } }, "S3VectorsEngine": { "target": "com.amazonaws.opensearch#S3VectorsEngine", "traits": { "smithy.api#documentation": "

Container for parameters representing the state of S3 vectors engine features on the\n specified domain.

" } }, "ServerlessVectorAcceleration": { "target": "com.amazonaws.opensearch#ServerlessVectorAcceleration", "traits": { "smithy.api#documentation": "

The current serverless vector acceleration configuration for the domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for parameters representing the state of machine learning features on the\n specified domain.

" } }, "com.amazonaws.opensearch#AIMLOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#AIMLOptionsOutput", "traits": { "smithy.api#documentation": "

Machine learning options on the specified domain.

" } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus" } }, "traits": { "smithy.api#documentation": "

The status of machine learning options on the specified domain.

" } }, "com.amazonaws.opensearch#AMPWorkspaceArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:aps:[a-z0-9-]+:[0-9]{12}:workspace\\/ws-[a-z0-9-]*$" } }, "com.amazonaws.opensearch#ARN": { "type": "string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in\n Using Amazon Web Services Identity and Access Management for\n more information.

", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#AWSAccount": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.opensearch#AWSDomainInformation": { "type": "structure", "members": { "OwnerId": { "target": "com.amazonaws.opensearch#OwnerId", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID of the domain owner.

" } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain.

", "smithy.api#required": {} } }, "Region": { "target": "com.amazonaws.opensearch#Region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region in which the domain is located.

" } } }, "traits": { "smithy.api#documentation": "

Information about an Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#AWSServicePrincipal": { "type": "enum", "members": { "application_opensearchservice_amazonaws_com": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application.opensearchservice.amazonaws.com" } } } }, "com.amazonaws.opensearch#AcceptInboundConnection": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AcceptInboundConnectionRequest" }, "output": { "target": "com.amazonaws.opensearch#AcceptInboundConnectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound\n cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept", "code": 200 } } }, "com.amazonaws.opensearch#AcceptInboundConnectionRequest": { "type": "structure", "members": { "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

The ID of the inbound connection to accept.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the AcceptInboundConnection\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#AcceptInboundConnectionResponse": { "type": "structure", "members": { "Connection": { "target": "com.amazonaws.opensearch#InboundConnection", "traits": { "smithy.api#documentation": "

Information about the accepted inbound connection.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about the accepted inbound connection.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#AcceptedWarningsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.opensearch#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An error occurred because you don't have permissions to access the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.opensearch#AccessPoliciesStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the access policy for the domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configured access rules for the domain's search endpoint, and the current status\n of those rules.

" } }, "com.amazonaws.opensearch#ActionSeverity": { "type": "enum", "members": { "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } } } }, "com.amazonaws.opensearch#ActionStatus": { "type": "enum", "members": { "PENDING_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_UPDATE" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "NOT_ELIGIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_ELIGIBLE" } }, "ELIGIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ELIGIBLE" } } } }, "com.amazonaws.opensearch#ActionType": { "type": "enum", "members": { "SERVICE_SOFTWARE_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_SOFTWARE_UPDATE" } }, "JVM_HEAP_SIZE_TUNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JVM_HEAP_SIZE_TUNING" } }, "JVM_YOUNG_GEN_TUNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JVM_YOUNG_GEN_TUNING" } } } }, "com.amazonaws.opensearch#AddDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AddDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#AddDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a new direct-query data source to the specified domain. For more information,\n see Creating Amazon OpenSearch Service data source integrations with Amazon\n S3.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", "code": 200 } } }, "com.amazonaws.opensearch#AddDataSourceRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain to add the data source to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { "smithy.api#documentation": "

A name for the data source.

", "smithy.api#required": {} } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DataSourceType", "traits": { "smithy.api#documentation": "

The type of data source.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#DataSourceDescription", "traits": { "smithy.api#documentation": "

A description of the data source.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the AddDataSource operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#AddDataSourceResponse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A message associated with creation of the data source.

" } } }, "traits": { "smithy.api#documentation": "

The result of an AddDataSource operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#AddDirectQueryDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AddDirectQueryDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#AddDirectQueryDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds a new data source in Amazon OpenSearch Service so that you can perform direct\n queries on external data.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/directQueryDataSource", "code": 200 } } }, "com.amazonaws.opensearch#AddDirectQueryDataSourceRequest": { "type": "structure", "members": { "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch\n Service environment.

", "smithy.api#required": {} } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { "smithy.api#documentation": "

The supported Amazon Web Services service that you want to use as the source for\n direct queries in OpenSearch Service.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { "smithy.api#documentation": "

An optional text field for providing additional context and details about the data\n source.

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { "smithy.api#documentation": "

An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are\n associated with the direct query data source. This field is required for CloudWatchLogs\n and SecurityLake datasource types.

" } }, "DataSourceAccessPolicy": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

An optional IAM access policy document that defines the permissions for accessing the data source.\n The policy document must be in valid JSON format and follow IAM policy syntax.

" } }, "TagList": { "target": "com.amazonaws.opensearch#TagList" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#AddDirectQueryDataSourceResponse": { "type": "structure", "members": { "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#AddReplicationPeer": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AddReplicationPeerRequest" }, "output": { "target": "com.amazonaws.opensearch#AddReplicationPeerResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Starts replicating a domain to a peer domain in another AWS Region. A domain can have one\n peer. The domain you call becomes the primary and the peer becomes the secondary, which\n receives a copy of the primary's indexes and serves read requests.

\n

Replication is established asynchronously. Use the DescribeDomainReplication operation to check whether the\n relationship has reached the ACTIVE state.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/replication/addPeer", "code": 200 } } }, "com.amazonaws.opensearch#AddReplicationPeerRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PeerDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain to replicate to. The peer must be in a\n different Region from the domain you are calling, and in the same AWS account.

", "smithy.api#required": {} } }, "DryRun": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

When true, validates the request and reports whether replication could be\n established, without changing either domain.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#AddReplicationPeerResponse": { "type": "structure", "members": { "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain that is now replicating to the peer.

" } }, "Status": { "target": "com.amazonaws.opensearch#ReplicationStatus", "traits": { "smithy.api#documentation": "

The state of the replication relationship. This is PENDING_SETUP immediately\n after the request is accepted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#AddTags": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AddTagsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Attaches tags to an existing Amazon OpenSearch Service domain, data source, or\n application.

\n

Tags are a set of case-sensitive key-value pairs. A domain, data source, or\n application can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service resources.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/tags", "code": 200 } } }, "com.amazonaws.opensearch#AddTagsRequest": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or\n application to which you want to attach resource tags.

", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.opensearch#TagList", "traits": { "smithy.api#documentation": "

List of resource tags.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the AddTags operation. Specifies the tags\n to attach to the domain, data source, or application.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#AdditionalLimit": { "type": "structure", "members": { "LimitName": { "target": "com.amazonaws.opensearch#LimitName", "traits": { "smithy.api#documentation": "" } }, "LimitValues": { "target": "com.amazonaws.opensearch#LimitValueList", "traits": { "smithy.api#documentation": "

The values of the additional instance type limits.

" } } }, "traits": { "smithy.api#documentation": "

List of limits that are specific to a given instance type.

" } }, "com.amazonaws.opensearch#AdditionalLimitList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AdditionalLimit" } }, "com.amazonaws.opensearch#AdvancedOptions": { "type": "map", "key": { "target": "com.amazonaws.opensearch#String" }, "value": { "target": "com.amazonaws.opensearch#String" }, "traits": { "smithy.api#documentation": "

Exposes native OpenSearch configuration values from opensearch.yml. The\n following advanced options are available:

\n \n

For more information, see Advanced cluster parameters.

" } }, "com.amazonaws.opensearch#AdvancedOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { "smithy.api#documentation": "

The status of advanced options for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of advanced options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Status of the advanced options for the specified domain. The following options are\n available:

\n \n

For more information, see Advanced cluster parameters.

" } }, "com.amazonaws.opensearch#AdvancedSecurityOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True if fine-grained access control is enabled.

" } }, "InternalUserDatabaseEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True if the internal user database is enabled.

" } }, "SAMLOptions": { "target": "com.amazonaws.opensearch#SAMLOptionsOutput", "traits": { "smithy.api#documentation": "

Container for information about the SAML configuration for OpenSearch\n Dashboards.

" } }, "JWTOptions": { "target": "com.amazonaws.opensearch#JWTOptionsOutput", "traits": { "smithy.api#documentation": "

Container for information about the JWT configuration of the Amazon OpenSearch\n Service.

" } }, "IAMFederationOptions": { "target": "com.amazonaws.opensearch#IAMFederationOptionsOutput", "traits": { "smithy.api#documentation": "

Configuration options for IAM identity federation in advanced security\n settings.

" } }, "AnonymousAuthDisableDate": { "target": "com.amazonaws.opensearch#DisableTimestamp", "traits": { "smithy.api#documentation": "

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

" } }, "AnonymousAuthEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True if a 30-day migration period is enabled, during which administrators can create\n role mappings. Only necessary when enabling fine-grained access control on an existing domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for fine-grained access control settings.

" } }, "com.amazonaws.opensearch#AdvancedSecurityOptionsInput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable fine-grained access control.

" } }, "InternalUserDatabaseEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable the internal user database.

" } }, "MasterUserOptions": { "target": "com.amazonaws.opensearch#MasterUserOptions", "traits": { "smithy.api#documentation": "

Container for information about the master user.

" } }, "SAMLOptions": { "target": "com.amazonaws.opensearch#SAMLOptionsInput", "traits": { "smithy.api#documentation": "

Container for information about the SAML configuration for OpenSearch\n Dashboards.

" } }, "JWTOptions": { "target": "com.amazonaws.opensearch#JWTOptionsInput", "traits": { "smithy.api#documentation": "

Container for information about the JWT configuration of the Amazon OpenSearch\n Service.

" } }, "IAMFederationOptions": { "target": "com.amazonaws.opensearch#IAMFederationOptionsInput", "traits": { "smithy.api#documentation": "

Input configuration for IAM identity federation within advanced security\n options.

" } }, "AnonymousAuthEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable a 30-day migration period during which administrators can create role\n mappings. Only necessary when enabling fine-grained access control on an existing domain.

" } } }, "traits": { "smithy.api#documentation": "

Options for enabling and configuring fine-grained access control. For more\n information, see Fine-grained access control\n in Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AdvancedSecurityOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#AdvancedSecurityOptions", "traits": { "smithy.api#documentation": "

Container for fine-grained access control settings.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

Status of the fine-grained access control settings for a domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of fine-grained access control settings for a domain.

" } }, "com.amazonaws.opensearch#AmazonOpenSearchService": { "type": "service", "version": "2021-01-01", "operations": [ { "target": "com.amazonaws.opensearch#AcceptInboundConnection" }, { "target": "com.amazonaws.opensearch#AddDataSource" }, { "target": "com.amazonaws.opensearch#AddDirectQueryDataSource" }, { "target": "com.amazonaws.opensearch#AddReplicationPeer" }, { "target": "com.amazonaws.opensearch#AddTags" }, { "target": "com.amazonaws.opensearch#AssociatePackage" }, { "target": "com.amazonaws.opensearch#AssociatePackages" }, { "target": "com.amazonaws.opensearch#AttachDataSource" }, { "target": "com.amazonaws.opensearch#AuthorizeVpcEndpointAccess" }, { "target": "com.amazonaws.opensearch#CancelDomainConfigChange" }, { "target": "com.amazonaws.opensearch#CancelServiceSoftwareUpdate" }, { "target": "com.amazonaws.opensearch#CompareDomainConfiguration" }, { "target": "com.amazonaws.opensearch#CreateApplication" }, { "target": "com.amazonaws.opensearch#CreateDomain" }, { "target": "com.amazonaws.opensearch#CreateIndex" }, { "target": "com.amazonaws.opensearch#CreateOutboundConnection" }, { "target": "com.amazonaws.opensearch#CreatePackage" }, { "target": "com.amazonaws.opensearch#CreateVpcEndpoint" }, { "target": "com.amazonaws.opensearch#DeleteApplication" }, { "target": "com.amazonaws.opensearch#DeleteDataSource" }, { "target": "com.amazonaws.opensearch#DeleteDirectQueryDataSource" }, { "target": "com.amazonaws.opensearch#DeleteDomain" }, { "target": "com.amazonaws.opensearch#DeleteInboundConnection" }, { "target": "com.amazonaws.opensearch#DeleteIndex" }, { "target": "com.amazonaws.opensearch#DeleteOutboundConnection" }, { "target": "com.amazonaws.opensearch#DeletePackage" }, { "target": "com.amazonaws.opensearch#DeleteVpcEndpoint" }, { "target": "com.amazonaws.opensearch#DeregisterCapability" }, { "target": "com.amazonaws.opensearch#DescribeDataSourceAttachment" }, { "target": "com.amazonaws.opensearch#DescribeDomain" }, { "target": "com.amazonaws.opensearch#DescribeDomainAutoTunes" }, { "target": "com.amazonaws.opensearch#DescribeDomainChangeProgress" }, { "target": "com.amazonaws.opensearch#DescribeDomainConfig" }, { "target": "com.amazonaws.opensearch#DescribeDomainHealth" }, { "target": "com.amazonaws.opensearch#DescribeDomainNodes" }, { "target": "com.amazonaws.opensearch#DescribeDomainReplication" }, { "target": "com.amazonaws.opensearch#DescribeDomains" }, { "target": "com.amazonaws.opensearch#DescribeDryRunProgress" }, { "target": "com.amazonaws.opensearch#DescribeInboundConnections" }, { "target": "com.amazonaws.opensearch#DescribeInsightDetails" }, { "target": "com.amazonaws.opensearch#DescribeInstanceTypeLimits" }, { "target": "com.amazonaws.opensearch#DescribeOutboundConnections" }, { "target": "com.amazonaws.opensearch#DescribePackages" }, { "target": "com.amazonaws.opensearch#DescribeReservedInstanceOfferings" }, { "target": "com.amazonaws.opensearch#DescribeReservedInstances" }, { "target": "com.amazonaws.opensearch#DescribeVpcEndpoints" }, { "target": "com.amazonaws.opensearch#DetachDataSource" }, { "target": "com.amazonaws.opensearch#DissociatePackage" }, { "target": "com.amazonaws.opensearch#DissociatePackages" }, { "target": "com.amazonaws.opensearch#FailoverReplication" }, { "target": "com.amazonaws.opensearch#GetApplication" }, { "target": "com.amazonaws.opensearch#GetCapability" }, { "target": "com.amazonaws.opensearch#GetCompatibleVersions" }, { "target": "com.amazonaws.opensearch#GetDataSource" }, { "target": "com.amazonaws.opensearch#GetDefaultApplicationSetting" }, { "target": "com.amazonaws.opensearch#GetDirectQueryDataSource" }, { "target": "com.amazonaws.opensearch#GetDomainMaintenanceStatus" }, { "target": "com.amazonaws.opensearch#GetIndex" }, { "target": "com.amazonaws.opensearch#GetMigration" }, { "target": "com.amazonaws.opensearch#GetPackageVersionHistory" }, { "target": "com.amazonaws.opensearch#GetUpgradeHistory" }, { "target": "com.amazonaws.opensearch#GetUpgradeStatus" }, { "target": "com.amazonaws.opensearch#InsightFeedback" }, { "target": "com.amazonaws.opensearch#ListApplications" }, { "target": "com.amazonaws.opensearch#ListDataSourceAttachments" }, { "target": "com.amazonaws.opensearch#ListDataSources" }, { "target": "com.amazonaws.opensearch#ListDirectQueryDataSources" }, { "target": "com.amazonaws.opensearch#ListDomainMaintenances" }, { "target": "com.amazonaws.opensearch#ListDomainNames" }, { "target": "com.amazonaws.opensearch#ListDomainsForPackage" }, { "target": "com.amazonaws.opensearch#ListInsights" }, { "target": "com.amazonaws.opensearch#ListInstanceTypeDetails" }, { "target": "com.amazonaws.opensearch#ListMigrations" }, { "target": "com.amazonaws.opensearch#ListPackagesForDomain" }, { "target": "com.amazonaws.opensearch#ListScheduledActions" }, { "target": "com.amazonaws.opensearch#ListTags" }, { "target": "com.amazonaws.opensearch#ListVersions" }, { "target": "com.amazonaws.opensearch#ListVpcEndpointAccess" }, { "target": "com.amazonaws.opensearch#ListVpcEndpoints" }, { "target": "com.amazonaws.opensearch#ListVpcEndpointsForDomain" }, { "target": "com.amazonaws.opensearch#PurchaseReservedInstanceOffering" }, { "target": "com.amazonaws.opensearch#PutDefaultApplicationSetting" }, { "target": "com.amazonaws.opensearch#RegisterCapability" }, { "target": "com.amazonaws.opensearch#RejectInboundConnection" }, { "target": "com.amazonaws.opensearch#RemoveReplicationPeer" }, { "target": "com.amazonaws.opensearch#RemoveTags" }, { "target": "com.amazonaws.opensearch#RevokeVpcEndpointAccess" }, { "target": "com.amazonaws.opensearch#RollbackServiceSoftwareUpdate" }, { "target": "com.amazonaws.opensearch#StartDomainMaintenance" }, { "target": "com.amazonaws.opensearch#StartMigration" }, { "target": "com.amazonaws.opensearch#StartServiceSoftwareUpdate" }, { "target": "com.amazonaws.opensearch#SwitchoverReplication" }, { "target": "com.amazonaws.opensearch#UpdateApplication" }, { "target": "com.amazonaws.opensearch#UpdateClone" }, { "target": "com.amazonaws.opensearch#UpdateDataSource" }, { "target": "com.amazonaws.opensearch#UpdateDirectQueryDataSource" }, { "target": "com.amazonaws.opensearch#UpdateDomainConfig" }, { "target": "com.amazonaws.opensearch#UpdateIndex" }, { "target": "com.amazonaws.opensearch#UpdatePackage" }, { "target": "com.amazonaws.opensearch#UpdatePackageScope" }, { "target": "com.amazonaws.opensearch#UpdateScheduledAction" }, { "target": "com.amazonaws.opensearch#UpdateVpcEndpoint" }, { "target": "com.amazonaws.opensearch#UpgradeDomain" } ], "traits": { "aws.api#service": { "sdkId": "OpenSearch", "arnNamespace": "es", "cloudFormationName": "OpenSearch", "cloudTrailEventSource": "opensearch.amazonaws.com", "endpointPrefix": "es" }, "aws.auth#sigv4": { "name": "es" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

Use the Amazon OpenSearch Service configuration API to create, configure, and manage\n OpenSearch Service domains. The endpoint for configuration service requests is Region\n specific: es.region.amazonaws.com. For example,\n es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see\n Amazon Web Services service endpoints.

", "smithy.api#title": "Amazon OpenSearch Service", "smithy.api#xmlNamespace": { "uri": "http://es.amazonaws.com/doc/2021-01-01/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://es-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://es-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://aos.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://aos.{Region}.api.amazonwebservices.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://es.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://es.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 16, "nodes": "/////wAAAAH/////AAAAAAAAAA8AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAsAAAAGAAAABAAAAAcF9eEMAAAABQAAAAgF9eELAAAABwX14QgAAAAJAAAACAX14QkAAAAKAAAACQX14QgF9eEKAAAABAAAAA0AAAAMAAAABgX14QYF9eEHAAAABQAAAA4F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAQAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://es-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://es-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://aos.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-cn", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://aos.{Region}.api.amazonwebservices.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://aos.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://es.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://es.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://es-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aos.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://es-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aos.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://es-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://aos.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://es-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.opensearch#AppConfig": { "type": "structure", "members": { "key": { "target": "com.amazonaws.opensearch#AppConfigType", "traits": { "smithy.api#documentation": "

The configuration item to set, such as the admin role for the OpenSearch\n application.

" } }, "value": { "target": "com.amazonaws.opensearch#AppConfigValue", "traits": { "smithy.api#documentation": "

The value assigned to the configuration key, such as an IAM user ARN.

" } } }, "traits": { "smithy.api#documentation": "

Configuration settings for an OpenSearch application. For more information, see Using the\n OpenSearch user interface in Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AppConfigType": { "type": "enum", "members": { "OpensearchDashboardAdminUsers": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "opensearchDashboards.dashboardAdmin.users" } }, "OpensearchDashboardAdminGroups": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "opensearchDashboards.dashboardAdmin.groups" } } } }, "com.amazonaws.opensearch#AppConfigValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.opensearch#AppConfigs": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AppConfig" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.opensearch#ApplicationId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9]{3,30}$" } }, "com.amazonaws.opensearch#ApplicationName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 30 }, "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.opensearch#ApplicationStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.opensearch#ApplicationStatuses": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ApplicationStatus" } }, "com.amazonaws.opensearch#ApplicationSummaries": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ApplicationSummary" } }, "com.amazonaws.opensearch#ApplicationSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of an OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { "smithy.api#documentation": "

The name of an OpenSearch application.

" } }, "endpoint": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The endpoint URL of an OpenSearch application.

" } }, "status": { "target": "com.amazonaws.opensearch#ApplicationStatus", "traits": { "smithy.api#documentation": "

The current status of an OpenSearch application. Possible values:\n CREATING, UPDATING, DELETING,\n FAILED, ACTIVE, and DELETED.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when an OpenSearch application was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp of the last update to an OpenSearch application.

" } } }, "traits": { "smithy.api#documentation": "

Basic details of an OpenSearch application.

" } }, "com.amazonaws.opensearch#AssociatePackage": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AssociatePackageRequest" }, "output": { "target": "com.amazonaws.opensearch#AssociatePackageResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Associates a package with an Amazon OpenSearch Service domain. For more information,\n see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/associate/{PackageID}/{DomainName}", "code": 200 } } }, "com.amazonaws.opensearch#AssociatePackageRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain to associate the package with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before the package\n specified in the request can be associated.

" } }, "AssociationConfiguration": { "target": "com.amazonaws.opensearch#PackageAssociationConfiguration", "traits": { "smithy.api#documentation": "

The configuration for associating a package with an Amazon OpenSearch Service\n domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the AssociatePackage\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#AssociatePackageResponse": { "type": "structure", "members": { "DomainPackageDetails": { "target": "com.amazonaws.opensearch#DomainPackageDetails", "traits": { "smithy.api#documentation": "

Information about a package that is associated with a domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the AssociatePackage\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#AssociatePackages": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AssociatePackagesRequest" }, "output": { "target": "com.amazonaws.opensearch#AssociatePackagesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Operation in the Amazon OpenSearch Service API for associating multiple packages with\n a domain simultaneously.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/associateMultiple", "code": 200 } } }, "com.amazonaws.opensearch#AssociatePackagesRequest": { "type": "structure", "members": { "PackageList": { "target": "com.amazonaws.opensearch#PackageDetailsForAssociationList", "traits": { "smithy.api#documentation": "

A list of packages and their prerequisites to be associated with a domain.

", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#AssociatePackagesResponse": { "type": "structure", "members": { "DomainPackageDetailsList": { "target": "com.amazonaws.opensearch#DomainPackageDetailsList", "traits": { "smithy.api#documentation": "

List of information about packages that are associated with a domain.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#AttachDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AttachDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#AttachDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Attaches a data source to an OpenSearch application. The data source must be an Amazon OpenSearch Service domain. If both the application and the data source are active, the attachment completes immediately with a status of ATTACHED. Otherwise, the operation returns PENDING and completes the attachment automatically once both become active. If the attachment cannot be completed, its status becomes FAILED. This operation is idempotent: If the data source is already attached or pending, the operation returns the existing attachment.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application/{id}/attachDataSource", "code": 200 } } }, "com.amazonaws.opensearch#AttachDataSourceRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with UpdateApplication, GetApplication, and DeleteApplication.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#required": {} } }, "workspaceId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The identifier of an existing workspace to update with the new data source. Mutually exclusive with workspaceConfiguration.

" } }, "workspaceConfiguration": { "target": "com.amazonaws.opensearch#WorkspaceConfigurationInput", "traits": { "smithy.api#documentation": "

Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with workspaceId.

" } }, "clientToken": { "target": "com.amazonaws.opensearch#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. If you retry a request with the same client token and the same parameters, the retry succeeds without performing any further actions.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#AttachDataSourceResponse": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier assigned to the data source attachment.

" } }, "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN" }, "status": { "target": "com.amazonaws.opensearch#DataSourceAttachmentStatus", "traits": { "smithy.api#documentation": "

The status of the data source attachment. Valid values are PENDING (waiting for resources to become active), ATTACHED (successfully attached), and FAILED (attachment timed out or encountered a non-retryable error).

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#AuthorizeVpcEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#AuthorizeVpcEndpointAccessRequest" }, "output": { "target": "com.amazonaws.opensearch#AuthorizeVpcEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Provides access to an Amazon OpenSearch Service domain through the use of an interface\n VPC endpoint.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess", "code": 200 } } }, "com.amazonaws.opensearch#AuthorizeVpcEndpointAccessRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the OpenSearch Service domain to provide access to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.opensearch#AWSAccount", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID to grant access to.

" } }, "Service": { "target": "com.amazonaws.opensearch#AWSServicePrincipal", "traits": { "smithy.api#documentation": "

The Amazon Web Services service SP to grant access to.

" } }, "ServiceOptions": { "target": "com.amazonaws.opensearch#ServiceOptions", "traits": { "smithy.api#documentation": "

The options for the service, including the supported Regions for the endpoint\n access.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#AuthorizeVpcEndpointAccessResponse": { "type": "structure", "members": { "AuthorizedPrincipal": { "target": "com.amazonaws.opensearch#AuthorizedPrincipal", "traits": { "smithy.api#documentation": "

Information about the Amazon Web Services account or service that was provided access\n to the domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#AuthorizedPrincipal": { "type": "structure", "members": { "PrincipalType": { "target": "com.amazonaws.opensearch#PrincipalType", "traits": { "smithy.api#documentation": "

The type of principal.

" } }, "Principal": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The IAM\n principal that is allowed access to the domain.

" } }, "ServiceOptions": { "target": "com.amazonaws.opensearch#ServiceOptions", "traits": { "smithy.api#documentation": "

The options for the service, including the supported Regions for the endpoint\n access.

" } } }, "traits": { "smithy.api#documentation": "

Information about an Amazon Web Services account or service that has access to an\n Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

" } }, "com.amazonaws.opensearch#AuthorizedPrincipalList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AuthorizedPrincipal" } }, "com.amazonaws.opensearch#AutoTune": { "type": "structure", "members": { "AutoTuneType": { "target": "com.amazonaws.opensearch#AutoTuneType", "traits": { "smithy.api#documentation": "

The type of Auto-Tune action.

" } }, "AutoTuneDetails": { "target": "com.amazonaws.opensearch#AutoTuneDetails", "traits": { "smithy.api#documentation": "

Details about an Auto-Tune action.

" } } }, "traits": { "smithy.api#documentation": "

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AutoTuneDate": { "type": "timestamp", "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#AutoTuneDesiredState": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#AutoTuneDetails": { "type": "structure", "members": { "ScheduledAutoTuneDetails": { "target": "com.amazonaws.opensearch#ScheduledAutoTuneDetails", "traits": { "smithy.api#documentation": "

Container for details about a scheduled Auto-Tune action.

" } } }, "traits": { "smithy.api#documentation": "

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AutoTuneList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AutoTune" } }, "com.amazonaws.opensearch#AutoTuneMaintenanceSchedule": { "type": "structure", "members": { "StartAt": { "target": "com.amazonaws.opensearch#StartAt", "traits": { "smithy.api#documentation": "

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

" } }, "Duration": { "target": "com.amazonaws.opensearch#Duration", "traits": { "smithy.api#documentation": "

The duration of the maintenance schedule. For example, \"Duration\": {\"Value\": 2,\n \"Unit\": \"HOURS\"}.

" } }, "CronExpressionForRecurrence": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A cron expression for a recurring maintenance schedule during which Auto-Tune can\n deploy changes.

" } } }, "traits": { "smithy.api#documentation": "\n

This object is deprecated. Use the domain's off-peak\n window to schedule Auto-Tune optimizations. For migration instructions,\n see Migrating from Auto-Tune maintenance windows.

\n
\n

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AutoTuneMaintenanceScheduleList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AutoTuneMaintenanceSchedule" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.opensearch#AutoTuneOptions": { "type": "structure", "members": { "DesiredState": { "target": "com.amazonaws.opensearch#AutoTuneDesiredState", "traits": { "smithy.api#documentation": "

Whether Auto-Tune is enabled or disabled.

" } }, "RollbackOnDisable": { "target": "com.amazonaws.opensearch#RollbackOnDisable", "traits": { "smithy.api#documentation": "

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior\n Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service\n defaults. If you specify DEFAULT_ROLLBACK, you must include a\n MaintenanceSchedule in the request. Otherwise, OpenSearch Service is\n unable to perform the rollback.

" } }, "MaintenanceSchedules": { "target": "com.amazonaws.opensearch#AutoTuneMaintenanceScheduleList", "traits": { "smithy.api#documentation": "

DEPRECATED. Use off-peak window\n instead.

\n

A list of maintenance schedules during which Auto-Tune can deploy changes.

" } }, "UseOffPeakWindow": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to use the domain's off-peak\n window to deploy configuration changes on the domain rather than a\n maintenance schedule.

" } } }, "traits": { "smithy.api#documentation": "

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AutoTuneOptionsInput": { "type": "structure", "members": { "DesiredState": { "target": "com.amazonaws.opensearch#AutoTuneDesiredState", "traits": { "smithy.api#documentation": "

Whether Auto-Tune is enabled or disabled.

" } }, "MaintenanceSchedules": { "target": "com.amazonaws.opensearch#AutoTuneMaintenanceScheduleList", "traits": { "smithy.api#documentation": "

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance\n windows are deprecated and have been replaced with off-peak\n windows.

" } }, "UseOffPeakWindow": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to schedule Auto-Tune optimizations that require blue/green deployments during\n the domain's configured daily off-peak window.

" } } }, "traits": { "smithy.api#documentation": "

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service\n

" } }, "com.amazonaws.opensearch#AutoTuneOptionsOutput": { "type": "structure", "members": { "State": { "target": "com.amazonaws.opensearch#AutoTuneState", "traits": { "smithy.api#documentation": "

The current state of Auto-Tune on the domain.

" } }, "ErrorMessage": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

Any errors that occurred while enabling or disabling Auto-Tune.

" } }, "UseOffPeakWindow": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather\n than a maintenance schedule.

" } } }, "traits": { "smithy.api#documentation": "

The Auto-Tune settings for a domain, displayed when enabling or disabling\n Auto-Tune.

" } }, "com.amazonaws.opensearch#AutoTuneOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#AutoTuneOptions", "traits": { "smithy.api#documentation": "

Auto-Tune settings for updating a domain.

" } }, "Status": { "target": "com.amazonaws.opensearch#AutoTuneStatus", "traits": { "smithy.api#documentation": "

The current status of Auto-Tune for a domain.

" } } }, "traits": { "smithy.api#documentation": "

The Auto-Tune status for the domain.

" } }, "com.amazonaws.opensearch#AutoTuneState": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ENABLE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLE_IN_PROGRESS" } }, "DISABLE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLE_IN_PROGRESS" } }, "DISABLED_AND_ROLLBACK_SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED_AND_ROLLBACK_SCHEDULED" } }, "DISABLED_AND_ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED_AND_ROLLBACK_IN_PROGRESS" } }, "DISABLED_AND_ROLLBACK_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED_AND_ROLLBACK_COMPLETE" } }, "DISABLED_AND_ROLLBACK_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED_AND_ROLLBACK_ERROR" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } }, "traits": { "smithy.api#documentation": "

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon\n OpenSearch Service.

" } }, "com.amazonaws.opensearch#AutoTuneStatus": { "type": "structure", "members": { "CreationDate": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

Date and time when Auto-Tune was enabled for the domain.

", "smithy.api#required": {} } }, "UpdateDate": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

Date and time when the Auto-Tune options were last updated for the domain.

", "smithy.api#required": {} } }, "UpdateVersion": { "target": "com.amazonaws.opensearch#UIntValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The latest version of the Auto-Tune options.

" } }, "State": { "target": "com.amazonaws.opensearch#AutoTuneState", "traits": { "smithy.api#documentation": "

The current state of Auto-Tune on the domain.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

Any errors that occurred while enabling or disabling Auto-Tune.

" } }, "PendingDeletion": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the domain is being deleted.

" } } }, "traits": { "smithy.api#documentation": "

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AutoTuneType": { "type": "enum", "members": { "SCHEDULED_ACTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULED_ACTION" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#AutomatedSnapshotPauseOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether automated snapshot pause is enabled for the domain.

", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp at which the automated snapshot pause begins.

" } }, "EndTime": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp at which the automated snapshot pause ends.

" } }, "State": { "target": "com.amazonaws.opensearch#PauseState", "traits": { "smithy.api#documentation": "

The current state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the automated snapshot pause options for the domain. These options allow you to temporarily pause automated snapshots for a specified time period.

" } }, "com.amazonaws.opensearch#AutomatedSnapshotPauseOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#AutomatedSnapshotPauseOptions", "traits": { "smithy.api#documentation": "

Automated snapshot pause options for the domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The current status of the automated snapshot pause options for the domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of automated snapshot pause options for the domain.

" } }, "com.amazonaws.opensearch#AutomatedSnapshotPauseRequestOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable or disable automated snapshot pause for the domain.

", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp at which the automated snapshot pause should begin.

" } }, "EndTime": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp at which the automated snapshot pause should end. The maximum allowed\n duration between StartTime and EndTime is 3 days.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the automated snapshot pause request options for the domain.

\n \n

Suspending snapshots reduces data protection. You cannot restore your domain to\n points in time when snapshots are suspended. Use this feature only for short-term\n operational needs such as migrations or maintenance windows.

\n
\n

Maximum suspension duration: 3 days.

" } }, "com.amazonaws.opensearch#AvailabilityZone": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 15 } } }, "com.amazonaws.opensearch#AvailabilityZoneInfo": { "type": "structure", "members": { "AvailabilityZoneName": { "target": "com.amazonaws.opensearch#AvailabilityZone", "traits": { "smithy.api#documentation": "

The name of the Availability Zone.

" } }, "ZoneStatus": { "target": "com.amazonaws.opensearch#ZoneStatus", "traits": { "smithy.api#documentation": "

The current state of the Availability Zone. Current options are Active\n and StandBy.

\n " } }, "ConfiguredDataNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { "smithy.api#documentation": "

The total number of data nodes configured in the Availability Zone.

" } }, "AvailableDataNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { "smithy.api#documentation": "

The number of data nodes active in the Availability Zone.

" } }, "TotalShards": { "target": "com.amazonaws.opensearch#NumberOfShards", "traits": { "smithy.api#documentation": "

The total number of primary and replica shards in the Availability Zone.

" } }, "TotalUnAssignedShards": { "target": "com.amazonaws.opensearch#NumberOfShards", "traits": { "smithy.api#documentation": "

The total number of primary and replica shards that aren't allocated to any of the\n nodes in the Availability Zone.

" } } }, "traits": { "smithy.api#documentation": "

Information about an Availability Zone on a domain.

" } }, "com.amazonaws.opensearch#AvailabilityZoneInfoList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AvailabilityZoneInfo" } }, "com.amazonaws.opensearch#AvailabilityZoneList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#AvailabilityZone" } }, "com.amazonaws.opensearch#BackendRole": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.opensearch#BaseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An error occurred while processing the request.

", "smithy.api#error": "client" } }, "com.amazonaws.opensearch#Boolean": { "type": "boolean" }, "com.amazonaws.opensearch#CancelDomainConfigChange": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CancelDomainConfigChangeRequest" }, "output": { "target": "com.amazonaws.opensearch#CancelDomainConfigChangeResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/config/cancel", "code": 200 } } }, "com.amazonaws.opensearch#CancelDomainConfigChangeRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DryRun": { "target": "com.amazonaws.opensearch#DryRun", "traits": { "smithy.api#documentation": "

When set to True, returns the list of change IDs and properties that will\n be cancelled without actually cancelling the change.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#CancelDomainConfigChangeResponse": { "type": "structure", "members": { "CancelledChangeIds": { "target": "com.amazonaws.opensearch#GUIDList", "traits": { "smithy.api#documentation": "

The unique identifiers of the changes that were cancelled.

" } }, "CancelledChangeProperties": { "target": "com.amazonaws.opensearch#CancelledChangePropertyList", "traits": { "smithy.api#documentation": "

The domain change properties that were cancelled.

" } }, "DryRun": { "target": "com.amazonaws.opensearch#DryRun", "traits": { "smithy.api#documentation": "

Whether or not the request was a dry run. If True, the changes were not\n actually cancelled.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#CancelServiceSoftwareUpdate": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CancelServiceSoftwareUpdateRequest" }, "output": { "target": "com.amazonaws.opensearch#CancelServiceSoftwareUpdateResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Cancels a scheduled service software update for an Amazon OpenSearch Service domain.\n You can only perform this operation before the AutomatedUpdateDate and when\n the domain's UpdateStatus is PENDING_UPDATE. For more\n information, see Service\n software updates in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/serviceSoftwareUpdate/cancel", "code": 200 } } }, "com.amazonaws.opensearch#CancelServiceSoftwareUpdateRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the OpenSearch Service domain that you want to cancel the service software\n update on.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to cancel a service software update.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#CancelServiceSoftwareUpdateResponse": { "type": "structure", "members": { "ServiceSoftwareOptions": { "target": "com.amazonaws.opensearch#ServiceSoftwareOptions", "traits": { "smithy.api#documentation": "

Container for the state of your domain relative to the latest service software.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response to a CancelServiceSoftwareUpdate operation.\n Contains the status of the update.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#CancelledChangeProperty": { "type": "structure", "members": { "PropertyName": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The name of the property whose change was cancelled.

" } }, "CancelledValue": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The pending value of the property that was cancelled. This would have been the\n eventual value of the property if the chance had not been cancelled.

" } }, "ActiveValue": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current value of the property, after the change was cancelled.

" } } }, "traits": { "smithy.api#documentation": "

A property change that was cancelled for an Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#CancelledChangePropertyList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#CancelledChangeProperty" } }, "com.amazonaws.opensearch#CapabilityBaseRequestConfig": { "type": "union", "members": { "aiConfig": { "target": "com.amazonaws.opensearch#AIConfig", "traits": { "smithy.api#documentation": "

Configuration settings for AI-powered capabilities.

" } } }, "traits": { "smithy.api#documentation": "

The base configuration for registering a capability. Contains capability-specific configuration such as AI settings.

" } }, "com.amazonaws.opensearch#CapabilityBaseResponseConfig": { "type": "union", "members": { "aiConfig": { "target": "com.amazonaws.opensearch#AIConfig", "traits": { "smithy.api#documentation": "

Configuration settings for AI-powered capabilities.

" } } }, "traits": { "smithy.api#documentation": "

The base configuration returned for a registered capability.

" } }, "com.amazonaws.opensearch#CapabilityExtendedResponseConfig": { "type": "union", "members": { "aiConfig": { "target": "com.amazonaws.opensearch#AIConfig", "traits": { "smithy.api#documentation": "

Configuration settings for AI-powered capabilities.

" } } }, "traits": { "smithy.api#documentation": "

The extended configuration returned for a registered capability, including additional details beyond the base configuration.

" } }, "com.amazonaws.opensearch#CapabilityFailure": { "type": "structure", "members": { "reason": { "target": "com.amazonaws.opensearch#CapabilityFailureReason", "traits": { "smithy.api#documentation": "

The reason for the capability failure. Possible values: KMS_KEY_INSUFFICIENT_PERMISSION.

" } }, "details": { "target": "com.amazonaws.opensearch#CapabilityFailureDetails", "traits": { "smithy.api#documentation": "

Additional details about the capability failure.

" } } }, "traits": { "smithy.api#documentation": "

Information about a capability failure.

" } }, "com.amazonaws.opensearch#CapabilityFailureDetails": { "type": "string" }, "com.amazonaws.opensearch#CapabilityFailureReason": { "type": "enum", "members": { "KMS_KEY_INSUFFICIENT_PERMISSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_KEY_INSUFFICIENT_PERMISSION" } } } }, "com.amazonaws.opensearch#CapabilityFailures": { "type": "list", "member": { "target": "com.amazonaws.opensearch#CapabilityFailure" }, "traits": { "smithy.api#documentation": "

A list of failures associated with a capability.

" } }, "com.amazonaws.opensearch#CapabilityName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of a capability. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens.

", "smithy.api#length": { "min": 3, "max": 30 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.opensearch#CapabilityStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "creating" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "create_failed" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "updating" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "update_failed" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deleting" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "delete_failed" } } }, "traits": { "smithy.api#documentation": "

The status of a capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

" } }, "com.amazonaws.opensearch#CategoryDiffResult": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.opensearch#DiffStatus", "traits": { "smithy.api#documentation": "

Whether the category was compared successfully. compared means the result is\n complete; error means the category could not be read.

" } }, "InSync": { "target": "com.amazonaws.opensearch#DiffCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of items that are identical on both domains.

" } }, "SourceOnly": { "target": "com.amazonaws.opensearch#DiffCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of items that exist only on the source domain.

" } }, "TargetOnly": { "target": "com.amazonaws.opensearch#DiffCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of items that exist only on the target domain.

" } }, "Diverged": { "target": "com.amazonaws.opensearch#DiffCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of items that exist on both domains but differ.

" } }, "Items": { "target": "com.amazonaws.opensearch#DiffItems", "traits": { "smithy.api#documentation": "

The names of the items that differ, and for diverging items, the fields that differ.

" } }, "Truncated": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether Items omits some differences because the category contained more than\n the response can carry. The counts remain complete when this is true.

" } } }, "traits": { "smithy.api#documentation": "

The result of comparing one metadata category between two domains.

" } }, "com.amazonaws.opensearch#ChangeProgressDetails": { "type": "structure", "members": { "ChangeId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The ID of the configuration change.

" } }, "Message": { "target": "com.amazonaws.opensearch#Message", "traits": { "smithy.api#documentation": "

A message corresponding to the status of the configuration change.

" } }, "ConfigChangeStatus": { "target": "com.amazonaws.opensearch#ConfigChangeStatus", "traits": { "smithy.api#documentation": "

The current status of the configuration change.

" } }, "InitiatedBy": { "target": "com.amazonaws.opensearch#InitiatedBy", "traits": { "smithy.api#documentation": "

The IAM principal who initiated the configuration change.

" } }, "StartTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time that the configuration change was initiated, in Universal Coordinated Time\n (UTC).

" } }, "LastUpdatedTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The last time that the configuration change was updated.

" } } }, "traits": { "smithy.api#documentation": "

Container for information about a configuration change happening on a domain.

" } }, "com.amazonaws.opensearch#ChangeProgressStage": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#ChangeProgressStageName", "traits": { "smithy.api#documentation": "

The name of the stage.

" } }, "Status": { "target": "com.amazonaws.opensearch#ChangeProgressStageStatus", "traits": { "smithy.api#documentation": "

The status of the stage.

" } }, "Description": { "target": "com.amazonaws.opensearch#Description", "traits": { "smithy.api#documentation": "

The description of the stage.

" } }, "LastUpdated": { "target": "com.amazonaws.opensearch#LastUpdated", "traits": { "smithy.api#documentation": "

The most recent updated timestamp of the stage.

" } } }, "traits": { "smithy.api#documentation": "

Progress details for each stage of a domain update.

" } }, "com.amazonaws.opensearch#ChangeProgressStageList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ChangeProgressStage" }, "traits": { "smithy.api#documentation": "

The list of progress stages of a specific domain configuration change.

" } }, "com.amazonaws.opensearch#ChangeProgressStageName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.opensearch#ChangeProgressStageStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.opensearch#ChangeProgressStatusDetails": { "type": "structure", "members": { "ChangeId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique change identifier associated with a specific domain configuration\n change.

" } }, "StartTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time at which the configuration change is made on the domain.

" } }, "Status": { "target": "com.amazonaws.opensearch#OverallChangeStatus", "traits": { "smithy.api#documentation": "

The overall status of the domain configuration change.

" } }, "PendingProperties": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

The list of properties in the domain configuration change that are still\n pending.

" } }, "CompletedProperties": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

The list of properties in the domain configuration change that have completed.

" } }, "TotalNumberOfStages": { "target": "com.amazonaws.opensearch#TotalNumberOfStages", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The total number of stages required for the configuration change.

" } }, "ChangeProgressStages": { "target": "com.amazonaws.opensearch#ChangeProgressStageList", "traits": { "smithy.api#documentation": "

The specific stages that the domain is going through to perform the configuration\n change.

" } }, "LastUpdatedTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The last time that the status of the configuration change was updated.

" } }, "ConfigChangeStatus": { "target": "com.amazonaws.opensearch#ConfigChangeStatus", "traits": { "smithy.api#documentation": "

The current status of the configuration change.

" } }, "InitiatedBy": { "target": "com.amazonaws.opensearch#InitiatedBy", "traits": { "smithy.api#documentation": "

The IAM principal who initiated the configuration change.

" } }, "ClonedBlueGreenUpgradeDetails": { "target": "com.amazonaws.opensearch#ClonedBlueGreenUpgradeDetails", "traits": { "smithy.api#documentation": "

Details about a cloned blue/green upgrade, when the change is one.

" } }, "ValidationFailures": { "target": "com.amazonaws.opensearch#ValidationFailures", "traits": { "smithy.api#documentation": "

The validation failures that occurred as a result of the configuration change.

" } }, "AcceptedWarnings": { "target": "com.amazonaws.opensearch#AcceptedWarningsList", "traits": { "smithy.api#documentation": "

The list of advisory warning codes that were accepted for the configuration change.

" } } }, "traits": { "smithy.api#documentation": "

The progress details of a specific domain configuration change.

" } }, "com.amazonaws.opensearch#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.opensearch#ClonedBlueGreenOptions": { "type": "structure", "members": { "RetentionOptions": { "target": "com.amazonaws.opensearch#RetentionOptions", "traits": { "smithy.api#documentation": "

How long to keep the cluster that you cut over from after cutover completes. When you start the upgrade, only RetentionInHours is accepted.

" } } }, "traits": { "smithy.api#documentation": "

Options for a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#ClonedBlueGreenScheduledAction": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.opensearch#ClonedBlueGreenScheduledActionType", "traits": { "smithy.api#documentation": "

The action that the service takes.

" } }, "ScheduledTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time at which the service takes the action.

" } } }, "traits": { "smithy.api#documentation": "

An action that the service takes automatically at a scheduled time during a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#ClonedBlueGreenScheduledActionType": { "type": "enum", "members": { "AUTOMATIC_CUTOVER_TO_PRIMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AutomaticCutoverToPrimaryCluster" } }, "DELETE_PRIMARY_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeletePrimaryCluster" } } }, "traits": { "smithy.api#documentation": "

\n AutomaticCutoverToPrimaryCluster cuts the domain back over to the primary cluster if you haven't cut over by the scheduled time. DeletePrimaryCluster deletes the primary cluster when the retention period ends.

" } }, "com.amazonaws.opensearch#ClonedBlueGreenUpgradeDetails": { "type": "structure", "members": { "TrafficSplit": { "target": "com.amazonaws.opensearch#TrafficPercents", "traits": { "smithy.api#documentation": "

The current split of search traffic between the primary and cloned clusters.

" } }, "ScheduledAction": { "target": "com.amazonaws.opensearch#ClonedBlueGreenScheduledAction", "traits": { "smithy.api#documentation": "

The action that the service takes automatically if you don't act before the scheduled time.

" } }, "RetentionInHours": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

The retention period, in hours, for the cluster that you cut over from.

" } } }, "traits": { "smithy.api#documentation": "

The state of a cloned blue/green upgrade. Members that don't apply are omitted.

" } }, "com.amazonaws.opensearch#CloudWatchDirectQueryDataSource": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceRoleArn", "traits": { "smithy.api#documentation": "

The unique identifier of the IAM role that grants OpenSearch Service permission to\n access the specified data source.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration details for a CloudWatch Logs data source that can be used for direct\n queries.

" } }, "com.amazonaws.opensearch#CloudWatchLogsLogGroupArn": { "type": "string", "traits": { "smithy.api#documentation": "

ARN of the Cloudwatch log group to publish logs to.

", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#ClusterConfig": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

Instance type of data nodes in the cluster.

" } }, "InstanceCount": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

Number of data nodes in the cluster. This number must be greater than 1, otherwise you\n receive a validation exception.

" } }, "DedicatedMasterEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether dedicated master nodes are enabled for the cluster.True\n if the cluster will use a dedicated master node.False if the cluster will\n not.

" } }, "ZoneAwarenessEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether multiple Availability Zones are enabled. For more information, see\n Configuring a multi-AZ domain in Amazon OpenSearch Service.

" } }, "ZoneAwarenessConfig": { "target": "com.amazonaws.opensearch#ZoneAwarenessConfig", "traits": { "smithy.api#documentation": "

Container for zone awareness configuration options. Only required if\n ZoneAwarenessEnabled is true.

" } }, "DedicatedMasterType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

OpenSearch Service instance type of the dedicated master nodes in the cluster.

" } }, "DedicatedMasterCount": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

Number of dedicated master nodes in the cluster. This number must be greater than 2\n and not 4, otherwise you receive a validation exception.

" } }, "WarmEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable warm storage for the cluster.

" } }, "WarmType": { "target": "com.amazonaws.opensearch#OpenSearchWarmPartitionInstanceType", "traits": { "smithy.api#documentation": "

The instance type for the cluster's warm nodes.

" } }, "WarmCount": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

The number of warm nodes in the cluster.

" } }, "ColdStorageOptions": { "target": "com.amazonaws.opensearch#ColdStorageOptions", "traits": { "smithy.api#documentation": "

Container for cold storage configuration options.

" } }, "MultiAZWithStandbyEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For\n more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

" } }, "NodeOptions": { "target": "com.amazonaws.opensearch#NodeOptionsList", "traits": { "smithy.api#documentation": "

List of node options for the domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for the cluster configuration of an OpenSearch Service domain. For more\n information, see Creating and\n managing Amazon OpenSearch Service domains.

" } }, "com.amazonaws.opensearch#ClusterConfigStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#ClusterConfig", "traits": { "smithy.api#documentation": "

Cluster configuration options for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of cluster configuration options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The cluster configuration status for a domain.

" } }, "com.amazonaws.opensearch#CognitoOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable or disable Amazon Cognito authentication for OpenSearch\n Dashboards.

" } }, "UserPoolId": { "target": "com.amazonaws.opensearch#UserPoolId", "traits": { "smithy.api#documentation": "

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch\n Dashboards authentication.

" } }, "IdentityPoolId": { "target": "com.amazonaws.opensearch#IdentityPoolId", "traits": { "smithy.api#documentation": "

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for\n OpenSearch Dashboards authentication.

" } }, "RoleArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { "smithy.api#documentation": "

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch\n Service to configure your user pool and identity pool.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters required to enable Cognito authentication for an\n OpenSearch Service domain. For more information, see Configuring Amazon\n Cognito authentication for OpenSearch Dashboards.

" } }, "com.amazonaws.opensearch#CognitoOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#CognitoOptions", "traits": { "smithy.api#documentation": "

Cognito options for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the Cognito options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of the Cognito options for the specified domain.

" } }, "com.amazonaws.opensearch#ColdStorageOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable or disable cold storage on the domain. You must enable UltraWarm\n storage to enable cold storage.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters required to enable cold storage for an OpenSearch Service\n domain. For more information, see Cold storage for\n Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#CommitMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 160 } } }, "com.amazonaws.opensearch#CompareDomainConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CompareDomainConfigurationRequest" }, "output": { "target": "com.amazonaws.opensearch#CompareDomainConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Compares the metadata of two domains and reports where they differ. Use this operation to\n check that a secondary domain is configured consistently with its primary before you rely on\n it, because replication copies index data but does not copy domain metadata such as index\n templates, ingest pipelines, or security roles.

\n

You choose which categories to compare. The response reports, for each category, how many\n items match, how many exist on only one domain, and which fields diverge.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/compareDomainConfiguration", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearch#CompareDomainConfigurationCategoryMap": { "type": "map", "key": { "target": "com.amazonaws.opensearch#MetadataCategory" }, "value": { "target": "com.amazonaws.opensearch#CategoryDiffResult" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.opensearch#CompareDomainConfigurationRequest": { "type": "structure", "members": { "SourceDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain to compare from.

", "smithy.api#required": {} } }, "TargetDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain to compare against.

", "smithy.api#required": {} } }, "Categories": { "target": "com.amazonaws.opensearch#MetadataCategoryList", "traits": { "smithy.api#documentation": "

The metadata categories to compare. At least one is required, and only the categories you\n name are read and returned.

\n \n

The set of categories grows over time, so this list is not fixed. A category the service does\n not recognise is rejected with the supported categories named in the error message.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#CompareDomainConfigurationResponse": { "type": "structure", "members": { "SourceDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain that was compared from.

" } }, "TargetDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain that was compared against.

" } }, "Categories": { "target": "com.amazonaws.opensearch#CompareDomainConfigurationCategoryMap", "traits": { "smithy.api#documentation": "

The comparison result for each category you requested, keyed by category name.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#CompatibleVersionsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#CompatibleVersionsMap" } }, "com.amazonaws.opensearch#CompatibleVersionsMap": { "type": "structure", "members": { "SourceVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

The current version that the OpenSearch Service domain is running.

" } }, "TargetVersions": { "target": "com.amazonaws.opensearch#VersionList", "traits": { "smithy.api#documentation": "

The possible versions that you can upgrade the domain to.

" } } }, "traits": { "smithy.api#documentation": "

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them\n to.

" } }, "com.amazonaws.opensearch#ConfigChangeStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "INITIALIZING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Initializing" } }, "VALIDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Validating" } }, "VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ValidationFailed" } }, "APPLYING_CHANGES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApplyingChanges" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "PENDING_USER_INPUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingUserInput" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelled" } } } }, "com.amazonaws.opensearch#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An error occurred because the client attempts to remove a resource that is currently in use.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#ConnectionAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-\\_]+$" } }, "com.amazonaws.opensearch#ConnectionId": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 256 }, "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.opensearch#ConnectionMode": { "type": "enum", "members": { "DIRECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECT" } }, "VPC_ENDPOINT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC_ENDPOINT" } } }, "traits": { "smithy.api#documentation": "

The connection mode for the cross-cluster connection.

\n " } }, "com.amazonaws.opensearch#ConnectionProperties": { "type": "structure", "members": { "Endpoint": { "target": "com.amazonaws.opensearch#Endpoint", "traits": { "smithy.api#documentation": "\n

The Endpoint attribute cannot be modified.

\n
\n

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

" } }, "CrossClusterSearch": { "target": "com.amazonaws.opensearch#CrossClusterSearchConnectionProperties", "traits": { "smithy.api#documentation": "

The connection properties for cross cluster search.

" } } }, "traits": { "smithy.api#documentation": "

The connection properties of an outbound connection.

" } }, "com.amazonaws.opensearch#ConnectionStatusMessage": { "type": "string" }, "com.amazonaws.opensearch#CreateApplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CreateApplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#CreateApplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application", "code": 200 } } }, "com.amazonaws.opensearch#CreateApplicationRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.opensearch#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { "smithy.api#documentation": "

The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.

", "smithy.api#required": {} } }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { "smithy.api#documentation": "

The data sources to link to the OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptionsInput", "traits": { "smithy.api#documentation": "

Configuration settings for integrating Amazon Web Services IAM Identity Center with the\n OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative\n options.

" } }, "tagList": { "target": "com.amazonaws.opensearch#TagList" }, "kmsKeyArn": { "target": "com.amazonaws.opensearch#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.\n If provided, the application uses your customer-managed key for encryption. If omitted, the application\n uses an AWS-managed key. The KMS key must be in the same region as the application.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#CreateApplicationResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier assigned to the OpenSearch application.

" } }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { "smithy.api#documentation": "

The data sources linked to the OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", "traits": { "smithy.api#documentation": "

The IAM Identity Center settings configured for the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative\n options.

" } }, "tagList": { "target": "com.amazonaws.opensearch#TagList" }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp indicating when the OpenSearch application was created.

" } }, "kmsKeyArn": { "target": "com.amazonaws.opensearch#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#CreateDomain": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CreateDomainRequest" }, "output": { "target": "com.amazonaws.opensearch#CreateDomainResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#InvalidTypeException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon OpenSearch Service domain. For more information, see Creating and\n managing Amazon OpenSearch Service domains.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain", "code": 200 } } }, "com.amazonaws.opensearch#CreateDomainRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the OpenSearch Service domain to create. Domain names are unique across the\n domains owned by an account within an Amazon Web Services Region.

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for\n the OpenSearch Service domain. For example, OpenSearch_1.0 or\n Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

" } }, "ClusterConfig": { "target": "com.amazonaws.opensearch#ClusterConfig", "traits": { "smithy.api#documentation": "

Container for the cluster configuration of a domain.

" } }, "EBSOptions": { "target": "com.amazonaws.opensearch#EBSOptions", "traits": { "smithy.api#documentation": "

Container for the parameters required to enable EBS-based storage for an OpenSearch\n Service domain.

" } }, "AccessPolicies": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

Identity and Access Management (IAM) policy document specifying the access policies\n for the new domain.

" } }, "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressType", "traits": { "smithy.api#documentation": "

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to\n share domain resources across IPv4 and IPv6 address types, and is the recommended\n option. If you set your IP address type to dual stack, you can't change your address\n type later.

" } }, "SnapshotOptions": { "target": "com.amazonaws.opensearch#SnapshotOptions", "traits": { "smithy.api#documentation": "

DEPRECATED. Container for the parameters required to configure automated snapshots of domain\n indexes.

" } }, "VPCOptions": { "target": "com.amazonaws.opensearch#VPCOptions", "traits": { "smithy.api#documentation": "

Container for the values required to configure VPC access domains. If you don't specify\n these values, OpenSearch Service creates the domain with a public endpoint. For more information,\n see Launching\n your Amazon OpenSearch Service domains using a VPC.

" } }, "CognitoOptions": { "target": "com.amazonaws.opensearch#CognitoOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to configure Amazon Cognito authentication. For more information, see\n Configuring Amazon\n Cognito authentication for OpenSearch Dashboards.

" } }, "EncryptionAtRestOptions": { "target": "com.amazonaws.opensearch#EncryptionAtRestOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to enable encryption at rest.

" } }, "NodeToNodeEncryptionOptions": { "target": "com.amazonaws.opensearch#NodeToNodeEncryptionOptions", "traits": { "smithy.api#documentation": "

Enables node-to-node encryption.

" } }, "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to specify advanced configuration options. The following key-value\n pairs are supported:

\n \n

For more information, see Advanced cluster parameters.

" } }, "LogPublishingOptions": { "target": "com.amazonaws.opensearch#LogPublishingOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to configure log publishing.

" } }, "DomainEndpointOptions": { "target": "com.amazonaws.opensearch#DomainEndpointOptions", "traits": { "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" } }, "AdvancedSecurityOptions": { "target": "com.amazonaws.opensearch#AdvancedSecurityOptionsInput", "traits": { "smithy.api#documentation": "

Options for fine-grained access control.

" } }, "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsInput", "traits": { "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within\n a domain.

" } }, "TagList": { "target": "com.amazonaws.opensearch#TagList", "traits": { "smithy.api#documentation": "

List of tags to add to the domain upon creation.

" } }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptionsInput", "traits": { "smithy.api#documentation": "

Options for Auto-Tune.

" } }, "OffPeakWindowOptions": { "target": "com.amazonaws.opensearch#OffPeakWindowOptions", "traits": { "smithy.api#documentation": "

Specifies a daily 10-hour time block during which OpenSearch Service can perform\n configuration changes on the domain, including service software updates and Auto-Tune\n enhancements that require a blue/green deployment. If no options are specified, the\n default start time of 10:00 P.M. local time (for the Region that the domain is created\n in) is used.

" } }, "SoftwareUpdateOptions": { "target": "com.amazonaws.opensearch#SoftwareUpdateOptions", "traits": { "smithy.api#documentation": "

Software update options for the domain.

" } }, "AIMLOptions": { "target": "com.amazonaws.opensearch#AIMLOptionsInput", "traits": { "smithy.api#documentation": "

Options for all machine learning features for the specified domain.

" } }, "DeploymentStrategyOptions": { "target": "com.amazonaws.opensearch#DeploymentStrategyOptions", "traits": { "smithy.api#documentation": "

Specifies the deployment strategy options for the domain.

" } }, "AutomatedSnapshotPauseOptions": { "target": "com.amazonaws.opensearch#AutomatedSnapshotPauseRequestOptions", "traits": { "smithy.api#documentation": "

Specifies the automated snapshot pause options for the domain.

\n \n

Suspending snapshots reduces data protection. You cannot restore your domain to\n points in time when snapshots are suspended. Use this feature only for short-term\n operational needs such as migrations or maintenance windows.

\n
\n

Maximum suspension duration: 3 days.

" } }, "UseCase": { "target": "com.amazonaws.opensearch#DomainUseCase", "traits": { "smithy.api#documentation": "

The primary use case for the domain. For valid values, see DomainUseCase.

" } }, "EngineMode": { "target": "com.amazonaws.opensearch#EngineMode", "traits": { "smithy.api#documentation": "

The engine mode for the domain. For valid values and requirements, see EngineMode.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#CreateDomainResponse": { "type": "structure", "members": { "DomainStatus": { "target": "com.amazonaws.opensearch#DomainStatus", "traits": { "smithy.api#documentation": "

The status of the newly created domain.

" } } }, "traits": { "smithy.api#documentation": "

The result of a CreateDomain operation. Contains the status of the newly\n created domain.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#CreateIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CreateIndexRequest" }, "output": { "target": "com.amazonaws.opensearch#CreateIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ThrottlingException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see Automatic semantic enrichment.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/index", "code": 200 } } }, "com.amazonaws.opensearch#CreateIndexRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IndexName": { "target": "com.amazonaws.opensearch#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.

", "smithy.api#required": {} } }, "IndexSchema": { "target": "com.amazonaws.opensearch#IndexSchema", "traits": { "smithy.api#documentation": "

The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#CreateIndexResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.opensearch#IndexStatus", "traits": { "smithy.api#documentation": "

The status of the index creation operation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#CreateOutboundConnection": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CreateOutboundConnectionRequest" }, "output": { "target": "com.amazonaws.opensearch#CreateOutboundConnectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain\n to a destination domain. For more information, see Cross-cluster search\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/cc/outboundConnection", "code": 200 } } }, "com.amazonaws.opensearch#CreateOutboundConnectionRequest": { "type": "structure", "members": { "LocalDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Name and Region of the source (local) domain.

", "smithy.api#required": {} } }, "RemoteDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Name and Region of the destination (remote) domain.

", "smithy.api#required": {} } }, "ConnectionAlias": { "target": "com.amazonaws.opensearch#ConnectionAlias", "traits": { "smithy.api#documentation": "

Name of the connection.

", "smithy.api#required": {} } }, "ConnectionMode": { "target": "com.amazonaws.opensearch#ConnectionMode", "traits": { "smithy.api#documentation": "

The connection mode.

" } }, "ConnectionProperties": { "target": "com.amazonaws.opensearch#ConnectionProperties", "traits": { "smithy.api#documentation": "

The ConnectionProperties for the outbound connection.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the CreateOutboundConnection operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#CreateOutboundConnectionResponse": { "type": "structure", "members": { "LocalDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Information about the source (local) domain.

" } }, "RemoteDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Information about the destination (remote) domain.

" } }, "ConnectionAlias": { "target": "com.amazonaws.opensearch#ConnectionAlias", "traits": { "smithy.api#documentation": "

Name of the connection.

" } }, "ConnectionStatus": { "target": "com.amazonaws.opensearch#OutboundConnectionStatus", "traits": { "smithy.api#documentation": "

The status of the connection.

" } }, "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

The unique identifier for the created outbound connection, which is used for subsequent\n operations on the connection.

" } }, "ConnectionMode": { "target": "com.amazonaws.opensearch#ConnectionMode", "traits": { "smithy.api#documentation": "

The connection mode.

" } }, "ConnectionProperties": { "target": "com.amazonaws.opensearch#ConnectionProperties", "traits": { "smithy.api#documentation": "

The ConnectionProperties for the newly created connection.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#CreatePackage": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CreatePackageRequest" }, "output": { "target": "com.amazonaws.opensearch#CreatePackageResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#InvalidTypeException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a package for use with Amazon OpenSearch Service domains. For more\n information, see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages", "code": 200 } } }, "com.amazonaws.opensearch#CreatePackageRequest": { "type": "structure", "members": { "PackageName": { "target": "com.amazonaws.opensearch#PackageName", "traits": { "smithy.api#documentation": "

Unique name for the package.

", "smithy.api#required": {} } }, "PackageType": { "target": "com.amazonaws.opensearch#PackageType", "traits": { "smithy.api#documentation": "

The type of package.

", "smithy.api#required": {} } }, "PackageDescription": { "target": "com.amazonaws.opensearch#PackageDescription", "traits": { "smithy.api#documentation": "

Description of the package.

" } }, "PackageSource": { "target": "com.amazonaws.opensearch#PackageSource", "traits": { "smithy.api#documentation": "

The Amazon S3 location from which to import the package.

", "smithy.api#required": {} } }, "PackageConfiguration": { "target": "com.amazonaws.opensearch#PackageConfiguration", "traits": { "smithy.api#documentation": "

The configuration parameters for the package being created.

" } }, "EngineVersion": { "target": "com.amazonaws.opensearch#EngineVersion", "traits": { "smithy.api#documentation": "

The version of the Amazon OpenSearch Service engine for which is compatible with the\n package. This can only be specified for package type ZIP-PLUGIN\n

" } }, "PackageVendingOptions": { "target": "com.amazonaws.opensearch#PackageVendingOptions", "traits": { "smithy.api#documentation": "

The vending options for the package being created. They determine if the package can\n be vended to other users.

" } }, "PackageEncryptionOptions": { "target": "com.amazonaws.opensearch#PackageEncryptionOptions", "traits": { "smithy.api#documentation": "

The encryption parameters for the package being created.

" } } }, "traits": { "smithy.api#documentation": "

Container for request parameters to the CreatePackage operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#CreatePackageResponse": { "type": "structure", "members": { "PackageDetails": { "target": "com.amazonaws.opensearch#PackageDetails", "traits": { "smithy.api#documentation": "

Basic information about an OpenSearch Service package.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the CreatePackage\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#CreateVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#CreateVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearch#CreateVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon OpenSearch Service-managed VPC endpoint.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/vpcEndpoints", "code": 200 } } }, "com.amazonaws.opensearch#CreateVpcEndpointRequest": { "type": "structure", "members": { "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

", "smithy.api#required": {} } }, "VpcOptions": { "target": "com.amazonaws.opensearch#VPCOptions", "traits": { "smithy.api#documentation": "

Options to specify the subnets and security groups for the endpoint.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.opensearch#ClientToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#CreateVpcEndpointResponse": { "type": "structure", "members": { "VpcEndpoint": { "target": "com.amazonaws.opensearch#VpcEndpoint", "traits": { "smithy.api#documentation": "

Information about the newly created VPC endpoint.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#CreatedAt": { "type": "timestamp" }, "com.amazonaws.opensearch#CrossClusterSearchConnectionProperties": { "type": "structure", "members": { "SkipUnavailable": { "target": "com.amazonaws.opensearch#SkipUnavailableStatus", "traits": { "smithy.api#documentation": "

The status of the SkipUnavailable setting for the outbound connection.\n This feature allows you to specify some clusters as optional and ensure that your\n cross-cluster queries return partial results despite failures on one or more remote\n clusters.

" } } }, "traits": { "smithy.api#documentation": "

Cross-cluster search specific connection properties.

" } }, "com.amazonaws.opensearch#CutoverOptions": { "type": "structure", "members": { "Target": { "target": "com.amazonaws.opensearch#CutoverTarget", "traits": { "smithy.api#documentation": "

The cluster that the domain is cutting over to.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#CutoverStatus", "traits": { "smithy.api#documentation": "

The status of the cutover.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The cutover target and status for a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#CutoverRequestOptions": { "type": "structure", "members": { "Target": { "target": "com.amazonaws.opensearch#CutoverTarget", "traits": { "smithy.api#documentation": "

The cluster to cut over to. ClonedCluster makes the cloned cluster serve the domain. PrimaryCluster keeps the primary cluster and ends the upgrade.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The cutover to perform for a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#CutoverStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } }, "traits": { "smithy.api#documentation": "

The status of a cutover.

" } }, "com.amazonaws.opensearch#CutoverTarget": { "type": "enum", "members": { "CLONED_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClonedCluster" } }, "PRIMARY_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PrimaryCluster" } } }, "traits": { "smithy.api#documentation": "

The cluster to cut over to in a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#DataSource": { "type": "structure", "members": { "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN" }, "dataSourceDescription": { "target": "com.amazonaws.opensearch#DataSourceDescription", "traits": { "smithy.api#documentation": "

Detailed description of a data source.

" } }, "iamRoleForDataSourceArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role to be used for cross account/region data source association.

" } } }, "traits": { "smithy.api#documentation": "

Data sources that are associated with an OpenSearch application.

" } }, "com.amazonaws.opensearch#DataSourceAttachmentStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ATTACHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTACHED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.opensearch#DataSourceAttachmentSummary": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier assigned to the data source attachment.

" } }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN" }, "status": { "target": "com.amazonaws.opensearch#DataSourceAttachmentStatus", "traits": { "smithy.api#documentation": "

The current status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED.

" } } }, "traits": { "smithy.api#documentation": "

Summary information about a data source attachment, including its identifier, data source ARN, and current status.

" } }, "com.amazonaws.opensearch#DataSourceAttachmentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DataSourceAttachmentSummary" } }, "com.amazonaws.opensearch#DataSourceDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" } }, "com.amazonaws.opensearch#DataSourceDetails": { "type": "structure", "members": { "DataSourceType": { "target": "com.amazonaws.opensearch#DataSourceType", "traits": { "smithy.api#documentation": "

The type of data source.

" } }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { "smithy.api#documentation": "

The name of the data source.

" } }, "Description": { "target": "com.amazonaws.opensearch#DataSourceDescription", "traits": { "smithy.api#documentation": "

A description of the data source.

" } }, "Status": { "target": "com.amazonaws.opensearch#DataSourceStatus", "traits": { "smithy.api#documentation": "

The status of the data source.

" } } }, "traits": { "smithy.api#documentation": "

Details about a direct-query data source.

" } }, "com.amazonaws.opensearch#DataSourceList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DataSourceDetails" } }, "com.amazonaws.opensearch#DataSourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 80 }, "smithy.api#pattern": "^[a-z][a-z0-9_]+$" } }, "com.amazonaws.opensearch#DataSourceStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.opensearch#DataSourceType": { "type": "union", "members": { "S3GlueDataCatalog": { "target": "com.amazonaws.opensearch#S3GlueDataCatalog", "traits": { "smithy.api#documentation": "

An Amazon S3 data source.

" } } }, "traits": { "smithy.api#documentation": "

The type of data source.

" } }, "com.amazonaws.opensearch#DataSources": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DataSource" } }, "com.amazonaws.opensearch#DeleteApplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteApplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteApplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a specified OpenSearch application.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/application/{id}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteApplicationRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteApplicationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeleteDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a direct-query data source. For more information, see Deleting\n an Amazon OpenSearch Service data source with Amazon S3.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteDataSourceRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { "smithy.api#documentation": "

The name of the data source to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DeleteDataSource operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteDataSourceResponse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A message associated with deletion of the data source.

" } } }, "traits": { "smithy.api#documentation": "

The result of a GetDataSource operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeleteDirectQueryDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteDirectQueryDataSourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a previously configured direct query data source from Amazon OpenSearch\n Service.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/directQueryDataSource/{DataSourceName}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteDirectQueryDataSourceRequest": { "type": "structure", "members": { "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch\n Service environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteDomain": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteDomainRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteDomainResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a\n domain after you delete it.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/domain/{DomainName}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteDomainRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain you want to permanently delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DeleteDomain operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteDomainResponse": { "type": "structure", "members": { "DomainStatus": { "target": "com.amazonaws.opensearch#DomainStatus", "traits": { "smithy.api#documentation": "

The status of the domain being deleted.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeleteInboundConnection": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteInboundConnectionRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteInboundConnectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Allows the destination Amazon OpenSearch Service domain owner to delete an existing\n inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteInboundConnectionRequest": { "type": "structure", "members": { "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

The ID of the inbound connection to permanently delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DeleteInboundConnection\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteInboundConnectionResponse": { "type": "structure", "members": { "Connection": { "target": "com.amazonaws.opensearch#InboundConnection", "traits": { "smithy.api#documentation": "

The deleted inbound connection.

" } } }, "traits": { "smithy.api#documentation": "

The results of a DeleteInboundConnection operation. Contains details\n about the deleted inbound connection.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeleteIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteIndexRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ThrottlingException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteIndexRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IndexName": { "target": "com.amazonaws.opensearch#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteIndexResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.opensearch#IndexStatus", "traits": { "smithy.api#documentation": "

The status of the index deletion operation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeleteOutboundConnection": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteOutboundConnectionRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteOutboundConnectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Allows the source Amazon OpenSearch Service domain owner to delete an existing\n outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteOutboundConnectionRequest": { "type": "structure", "members": { "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DeleteOutboundConnection\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteOutboundConnectionResponse": { "type": "structure", "members": { "Connection": { "target": "com.amazonaws.opensearch#OutboundConnection", "traits": { "smithy.api#documentation": "

The deleted inbound connection.

" } } }, "traits": { "smithy.api#documentation": "

Details about the deleted outbound connection.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeletePackage": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeletePackageRequest" }, "output": { "target": "com.amazonaws.opensearch#DeletePackageResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/packages/{PackageID}", "code": 200 } } }, "com.amazonaws.opensearch#DeletePackageRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Deletes a package from OpenSearch Service. The package can't be associated with any\n OpenSearch Service domain.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeletePackageResponse": { "type": "structure", "members": { "PackageDetails": { "target": "com.amazonaws.opensearch#PackageDetails", "traits": { "smithy.api#documentation": "

Information about the deleted package.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response parameters to the DeletePackage\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DeleteVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeleteVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearch#DeleteVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}", "code": 200 } } }, "com.amazonaws.opensearch#DeleteVpcEndpointRequest": { "type": "structure", "members": { "VpcEndpointId": { "target": "com.amazonaws.opensearch#VpcEndpointId", "traits": { "smithy.api#documentation": "

The unique identifier of the endpoint.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeleteVpcEndpointResponse": { "type": "structure", "members": { "VpcEndpointSummary": { "target": "com.amazonaws.opensearch#VpcEndpointSummary", "traits": { "smithy.api#documentation": "

Information about the deleted endpoint, including its current status\n (DELETING or DELETE_FAILED).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DependencyFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 424 } }, "com.amazonaws.opensearch#DeploymentCloseDateTimeStamp": { "type": "timestamp" }, "com.amazonaws.opensearch#DeploymentStatus": { "type": "enum", "members": { "PENDING_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_UPDATE" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "NOT_ELIGIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_ELIGIBLE" } }, "ELIGIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ELIGIBLE" } } } }, "com.amazonaws.opensearch#DeploymentStrategy": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Default" } }, "CAPACITY_OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CapacityOptimized" } } }, "traits": { "smithy.api#documentation": "

Specifies the deployment strategy for the domain. Valid values are Default and CapacityOptimized.

" } }, "com.amazonaws.opensearch#DeploymentStrategyOptions": { "type": "structure", "members": { "DeploymentStrategy": { "target": "com.amazonaws.opensearch#DeploymentStrategy", "traits": { "smithy.api#documentation": "

Specifies the deployment strategy for the domain. Valid values are Default and CapacityOptimized.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the deployment strategy options for the domain.

" } }, "com.amazonaws.opensearch#DeploymentStrategyOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#DeploymentStrategyOptions", "traits": { "smithy.api#documentation": "

Deployment strategy options for the domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The current status of the deployment strategy options for the domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of deployment strategy options for the domain.

" } }, "com.amazonaws.opensearch#DeploymentStrategyOverride": { "type": "enum", "members": { "CLONED_BLUE_GREEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClonedBlueGreen" } } }, "traits": { "smithy.api#documentation": "

The deployment strategy override for an operation. The only valid value is ClonedBlueGreen.

" } }, "com.amazonaws.opensearch#DeploymentStrategyOverrideOptions": { "type": "structure", "members": { "DeploymentStrategy": { "target": "com.amazonaws.opensearch#DeploymentStrategyOverride", "traits": { "smithy.api#documentation": "

The deployment strategy to use for this operation. The only valid value is ClonedBlueGreen, which creates a cloned cluster on the target version next to the primary cluster so that you can validate it and shift traffic to it before you cut over.

", "smithy.api#required": {} } }, "ClonedBlueGreenOptions": { "target": "com.amazonaws.opensearch#ClonedBlueGreenOptions", "traits": { "smithy.api#documentation": "

Options that apply when DeploymentStrategy is ClonedBlueGreen.

" } } }, "traits": { "smithy.api#documentation": "

Overrides the deployment strategy for a single operation, such as a version upgrade.

" } }, "com.amazonaws.opensearch#DeploymentType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 128 } } }, "com.amazonaws.opensearch#DeregisterCapability": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DeregisterCapabilityRequest" }, "output": { "target": "com.amazonaws.opensearch#DeregisterCapabilityResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/application/{applicationId}/capability/deregister/{capabilityName}", "code": 200 } } }, "com.amazonaws.opensearch#DeregisterCapabilityRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch UI application to deregister the capability from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "capabilityName": { "target": "com.amazonaws.opensearch#CapabilityName", "traits": { "smithy.api#documentation": "

The name of the capability to deregister.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DeregisterCapability operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DeregisterCapabilityResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.opensearch#CapabilityStatus", "traits": { "smithy.api#documentation": "

The status of the deregistration operation. Returns deleting when the capability is being removed.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DeregisterCapability request.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDataSourceAttachment": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDataSourceAttachmentRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDataSourceAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the current status and details of a specific data source attachment for an OpenSearch application. Throws a ResourceNotFoundException if no attachment record exists for the specified application and data source combination.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application/{id}/describeDataSourceAttachment", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDataSourceAttachmentRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier or name of the OpenSearch application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDataSourceAttachmentResponse": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier assigned to the data source attachment.

" } }, "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN" }, "status": { "target": "com.amazonaws.opensearch#DataSourceAttachmentStatus", "traits": { "smithy.api#documentation": "

The status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomain": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the domain configuration for the specified Amazon OpenSearch Service domain,\n including the domain ID, domain service endpoint, and domain ARN.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDomainAutoTunes": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainAutoTunesRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainAutoTunesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch\n Service domain. For more information, see Auto-Tune for Amazon\n OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/autoTunes", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#DescribeDomainAutoTunesRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain that you want Auto-Tune details about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomainAutoTunes\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainAutoTunesResponse": { "type": "structure", "members": { "AutoTunes": { "target": "com.amazonaws.opensearch#AutoTuneList", "traits": { "smithy.api#documentation": "

The list of setting adjustments that Auto-Tune has made to the domain.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeDomainAutoTunes request.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomainChangeProgress": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainChangeProgressRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainChangeProgressResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about the current blue/green deployment happening on an Amazon\n OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/progress", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDomainChangeProgressRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain to get progress information for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChangeId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The specific change ID for which you want to get progress information. If omitted, the\n request returns information about the most recent configuration change.

", "smithy.api#httpQuery": "changeid" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomainChangeProgress\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainChangeProgressResponse": { "type": "structure", "members": { "ChangeProgressStatus": { "target": "com.amazonaws.opensearch#ChangeProgressStatusDetails", "traits": { "smithy.api#documentation": "

Container for information about the stages of a configuration change happening on a\n domain.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeDomainChangeProgress request. Contains progress\n information for the requested domain change.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomainConfig": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainConfigRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainConfigResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the configuration of an Amazon OpenSearch Service domain.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/config", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDomainConfigRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the OpenSearch Service domain configuration that you want to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomainConfig\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainConfigResponse": { "type": "structure", "members": { "DomainConfig": { "target": "com.amazonaws.opensearch#DomainConfig", "traits": { "smithy.api#documentation": "

Container for the configuration of the OpenSearch Service domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the configuration information of the requested domain.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomainHealth": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainHealthRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainHealthResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about domain and node health, the standby Availability Zone,\n number of nodes per Availability Zone, and shard count per node.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/health", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDomainHealthRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomainHealth\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainHealthResponse": { "type": "structure", "members": { "DomainState": { "target": "com.amazonaws.opensearch#DomainState", "traits": { "smithy.api#documentation": "

The current state of the domain.

\n " } }, "AvailabilityZoneCount": { "target": "com.amazonaws.opensearch#NumberOfAZs", "traits": { "smithy.api#documentation": "

The number of Availability Zones configured for the domain. If the service is unable\n to fetch this information, it will return NotAvailable.

" } }, "ActiveAvailabilityZoneCount": { "target": "com.amazonaws.opensearch#NumberOfAZs", "traits": { "smithy.api#documentation": "

The number of active Availability Zones configured for the domain. If the service is\n unable to fetch this information, it will return NotAvailable.

" } }, "StandByAvailabilityZoneCount": { "target": "com.amazonaws.opensearch#NumberOfAZs", "traits": { "smithy.api#documentation": "

The number of standby Availability Zones configured for the domain. If the service is\n unable to fetch this information, it will return NotAvailable.

" } }, "DataNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { "smithy.api#documentation": "

The number of data nodes configured for the domain. If the service is unable to fetch\n this information, it will return NotAvailable.

" } }, "DedicatedMaster": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

A boolean that indicates if dedicated master nodes are activated for the\n domain.

" } }, "MasterEligibleNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { "smithy.api#documentation": "

The number of nodes that can be elected as a master node. If dedicated master nodes is\n turned on, this value is the number of dedicated master nodes configured for the domain.\n If the service is unable to fetch this information, it will return\n NotAvailable.

" } }, "WarmNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { "smithy.api#documentation": "

The number of warm nodes configured for the domain.

" } }, "MasterNode": { "target": "com.amazonaws.opensearch#MasterNodeStatus", "traits": { "smithy.api#documentation": "

Indicates whether the domain has an elected master node.

\n " } }, "ClusterHealth": { "target": "com.amazonaws.opensearch#DomainHealth", "traits": { "smithy.api#documentation": "

The current health status of your cluster.

\n " } }, "TotalShards": { "target": "com.amazonaws.opensearch#NumberOfShards", "traits": { "smithy.api#documentation": "

The total number of primary and replica shards for the domain.

" } }, "TotalUnAssignedShards": { "target": "com.amazonaws.opensearch#NumberOfShards", "traits": { "smithy.api#documentation": "

The total number of primary and replica shards not allocated to any of the nodes for\n the cluster.

" } }, "EnvironmentInformation": { "target": "com.amazonaws.opensearch#EnvironmentInfoList", "traits": { "smithy.api#documentation": "

A list of EnvironmentInfo for the domain.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeDomainHealth request. Contains health information\n for the requested domain.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomainNodes": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainNodesRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainNodesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about domain and nodes, including data nodes, master nodes,\n ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node\n states.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/nodes", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDomainNodesRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomainNodes operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainNodesResponse": { "type": "structure", "members": { "DomainNodesStatusList": { "target": "com.amazonaws.opensearch#DomainNodesStatusList", "traits": { "smithy.api#documentation": "

Contains nodes information list DomainNodesStatusList with details about\n the all nodes on the requested domain.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeDomainNodes request. Contains information about\n the nodes on the requested domain.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomainReplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainReplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainReplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the replication arrangement that a domain participates in, including the domain's\n role and the state of its relationship with each peer.

\n

A domain that is not replicating is returned with an empty Peers list and no\n Role. Returns ResourceNotFoundException if the domain does not\n exist.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/replication", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.opensearch#DescribeDomainReplicationRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainReplicationResponse": { "type": "structure", "members": { "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain described.

" } }, "Role": { "target": "com.amazonaws.opensearch#ReplicationRole", "traits": { "smithy.api#documentation": "

The domain's role in the arrangement, either PRIMARY or\n SECONDARY. Absent when the domain is not replicating.

" } }, "Peers": { "target": "com.amazonaws.opensearch#ReplicationPeerList", "traits": { "smithy.api#documentation": "

The domains that this domain replicates with. Each entry carries the state of that one\n relationship. Empty when the domain is not replicating.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomainRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain that you want information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomain operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainResponse": { "type": "structure", "members": { "DomainStatus": { "target": "com.amazonaws.opensearch#DomainStatus", "traits": { "smithy.api#documentation": "

List that contains the status of each specified OpenSearch Service domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the status of the domain specified in the request.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDomains": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDomainsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDomainsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns domain configuration information about the specified Amazon OpenSearch Service\n domains.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain-info", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDomainsRequest": { "type": "structure", "members": { "DomainNames": { "target": "com.amazonaws.opensearch#DomainNameList", "traits": { "smithy.api#documentation": "

Array of OpenSearch Service domain names that you want information about. You must\n specify at least one domain name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeDomains operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDomainsResponse": { "type": "structure", "members": { "DomainStatusList": { "target": "com.amazonaws.opensearch#DomainStatusList", "traits": { "smithy.api#documentation": "

The status of the requested domains.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the status of the specified domains or all domains owned by the\n account.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeDryRunProgress": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeDryRunProgressRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeDryRunProgressResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch\n Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dryRun", "code": 200 } } }, "com.amazonaws.opensearch#DescribeDryRunProgressRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DryRunId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier of the dry run.

", "smithy.api#httpQuery": "dryRunId" } }, "LoadDryRunConfig": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to include the configuration of the dry run in the response. The configuration\n specifies the updates that you're planning to make on the domain.

", "smithy.api#httpQuery": "loadDryRunConfig" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeDryRunProgressResponse": { "type": "structure", "members": { "DryRunProgressStatus": { "target": "com.amazonaws.opensearch#DryRunProgressStatus", "traits": { "smithy.api#documentation": "

The current status of the dry run, including any validation errors.

" } }, "DryRunConfig": { "target": "com.amazonaws.opensearch#DomainStatus", "traits": { "smithy.api#documentation": "

Details about the changes you're planning to make on the domain.

" } }, "DryRunResults": { "target": "com.amazonaws.opensearch#DryRunResults", "traits": { "smithy.api#documentation": "

The results of the dry run.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeInboundConnections": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeInboundConnectionsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeInboundConnectionsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InvalidPaginationTokenException" } ], "traits": { "smithy.api#documentation": "

Lists all the inbound cross-cluster search connections for a destination (remote)\n Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/cc/inboundConnection/search", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#DescribeInboundConnectionsRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.opensearch#FilterList", "traits": { "smithy.api#documentation": "

A list of filters used to match properties for inbound cross-cluster\n connections.

" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeInboundConnections\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeInboundConnectionsResponse": { "type": "structure", "members": { "Connections": { "target": "com.amazonaws.opensearch#InboundConnections", "traits": { "smithy.api#documentation": "

List of inbound connections.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Contains a list of connections matching the filter criteria.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeInsightDetails": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeInsightDetailsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeInsightDetailsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the details of an existing insight for an Amazon OpenSearch Service domain.\n Returns detailed fields associated with the specified insight, such as text descriptions\n and metric data.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/insight-details", "code": 200 } } }, "com.amazonaws.opensearch#DescribeInsightDetailsRequest": { "type": "structure", "members": { "Entity": { "target": "com.amazonaws.opensearch#InsightEntity", "traits": { "smithy.api#documentation": "

The entity for which to retrieve insight details. Specifies the type and value of the\n entity, such as a domain name or Amazon Web Services account ID.

", "smithy.api#required": {} } }, "InsightId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier of the insight to describe.

", "smithy.api#required": {} } }, "ShowHtmlContent": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to show response with HTML content in response or not.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeInsightDetails\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeInsightDetailsResponse": { "type": "structure", "members": { "Fields": { "target": "com.amazonaws.opensearch#InsightFieldList", "traits": { "smithy.api#documentation": "

The list of fields that contain detailed information about the insight.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeInsightDetails request. Contains the detailed\n fields associated with the specified insight.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeInstanceTypeLimits": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeInstanceTypeLimitsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeInstanceTypeLimitsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#InvalidTypeException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the instance count, storage, and master node limits for a given OpenSearch\n or Elasticsearch version and instance type.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}", "code": 200 } } }, "com.amazonaws.opensearch#DescribeInstanceTypeLimitsRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain. Only specify if you need the limits for an existing\n domain.

", "smithy.api#httpQuery": "domainName" } }, "InstanceType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

The OpenSearch Service instance type for which you need limit information.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or\n OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeInstanceTypeLimits\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeInstanceTypeLimitsResponse": { "type": "structure", "members": { "LimitsByRole": { "target": "com.amazonaws.opensearch#LimitsByRole", "traits": { "smithy.api#documentation": "

Map that contains all applicable instance type limits.data refers to data\n nodes.master refers to dedicated master nodes.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters received from the DescribeInstanceTypeLimits\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeOutboundConnections": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeOutboundConnectionsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeOutboundConnectionsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InvalidPaginationTokenException" } ], "traits": { "smithy.api#documentation": "

Lists all the outbound cross-cluster connections for a local (source) Amazon\n OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/cc/outboundConnection/search", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#DescribeOutboundConnectionsRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.opensearch#FilterList", "traits": { "smithy.api#documentation": "

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

" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the DescribeOutboundConnections\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeOutboundConnectionsResponse": { "type": "structure", "members": { "Connections": { "target": "com.amazonaws.opensearch#OutboundConnections", "traits": { "smithy.api#documentation": "

List of outbound connections that match the filter criteria.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Contains a list of connections matching the filter criteria.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribePackages": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribePackagesRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribePackagesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes all packages available to OpenSearch Service. For more information, see\n Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/describe", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#DescribePackagesFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#DescribePackagesFilterName", "traits": { "smithy.api#documentation": "

Any field from PackageDetails.

" } }, "Value": { "target": "com.amazonaws.opensearch#DescribePackagesFilterValues", "traits": { "smithy.api#documentation": "

A non-empty list of values for the specified filter field.

" } } }, "traits": { "smithy.api#documentation": "

A filter to apply to the DescribePackage response.

" } }, "com.amazonaws.opensearch#DescribePackagesFilterList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DescribePackagesFilter" }, "traits": { "smithy.api#documentation": "

A list of DescribePackagesFilter to filter the packages included in a\n DescribePackages response.

" } }, "com.amazonaws.opensearch#DescribePackagesFilterName": { "type": "enum", "members": { "PackageID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PackageID" } }, "PackageName": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PackageName" } }, "PackageStatus": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PackageStatus" } }, "PackageType": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PackageType" } }, "EngineVersion": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngineVersion" } }, "PackageOwner": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PackageOwner" } } } }, "com.amazonaws.opensearch#DescribePackagesFilterValue": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-zA-Z\\*\\.\\_\\\\\\/\\?-]+$" } }, "com.amazonaws.opensearch#DescribePackagesFilterValues": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DescribePackagesFilterValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.opensearch#DescribePackagesRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.opensearch#DescribePackagesFilterList", "traits": { "smithy.api#documentation": "

Only returns packages that match the DescribePackagesFilterList\n values.

" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the DescribePackage\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribePackagesResponse": { "type": "structure", "members": { "PackageDetailsList": { "target": "com.amazonaws.opensearch#PackageDetailsList", "traits": { "smithy.api#documentation": "

Basic information about a package.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the DescribePackages\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeReservedInstanceOfferings": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeReservedInstanceOfferingsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeReservedInstanceOfferingsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a\n given Region. For more information, see Reserved Instances in Amazon\n OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/reservedInstanceOfferings", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#DescribeReservedInstanceOfferingsRequest": { "type": "structure", "members": { "ReservedInstanceOfferingId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The Reserved Instance identifier filter value. Use this parameter to show only the\n available instance types that match the specified reservation identifier.

", "smithy.api#httpQuery": "offeringId" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to a\n DescribeReservedInstanceOfferings operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeReservedInstanceOfferingsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } }, "ReservedInstanceOfferings": { "target": "com.amazonaws.opensearch#ReservedInstanceOfferingList", "traits": { "smithy.api#documentation": "

List of Reserved Instance offerings.

" } } }, "traits": { "smithy.api#documentation": "

Container for results of a DescribeReservedInstanceOfferings\n request.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeReservedInstances": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeReservedInstancesRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeReservedInstancesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the Amazon OpenSearch Service instances that you have reserved in a given\n Region. For more information, see Reserved Instances in Amazon\n OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/reservedInstances", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#DescribeReservedInstancesRequest": { "type": "structure", "members": { "ReservedInstanceId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The reserved instance identifier filter value. Use this parameter to show only the\n reservation that matches the specified reserved OpenSearch instance ID.

", "smithy.api#httpQuery": "reservationId" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the DescribeReservedInstances\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeReservedInstancesResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } }, "ReservedInstances": { "target": "com.amazonaws.opensearch#ReservedInstanceList", "traits": { "smithy.api#documentation": "

List of Reserved Instances in the current Region.

" } } }, "traits": { "smithy.api#documentation": "

Container for results from DescribeReservedInstances\n

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DescribeVpcEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DescribeVpcEndpointsRequest" }, "output": { "target": "com.amazonaws.opensearch#DescribeVpcEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/vpcEndpoints/describe", "code": 200 } } }, "com.amazonaws.opensearch#DescribeVpcEndpointsRequest": { "type": "structure", "members": { "VpcEndpointIds": { "target": "com.amazonaws.opensearch#VpcEndpointIdList", "traits": { "smithy.api#documentation": "

The unique identifiers of the endpoints to get information about.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DescribeVpcEndpointsResponse": { "type": "structure", "members": { "VpcEndpoints": { "target": "com.amazonaws.opensearch#VpcEndpoints", "traits": { "smithy.api#documentation": "

Information about each requested VPC endpoint.

", "smithy.api#required": {} } }, "VpcEndpointErrors": { "target": "com.amazonaws.opensearch#VpcEndpointErrorList", "traits": { "smithy.api#documentation": "

Any errors associated with the request.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#Description": { "type": "string" }, "com.amazonaws.opensearch#DetachDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DetachDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#DetachDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes a data source from an OpenSearch application. The application must be in the ACTIVE state. This operation removes the data source saved object from the application and deletes the attachment record. Throws a ConflictException if the specified data source has a PENDING attachment, and a ResourceNotFoundException if the data source is not currently attached to the application.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application/{id}/detachDataSource", "code": 200 } } }, "com.amazonaws.opensearch#DetachDataSourceRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier or name of the OpenSearch application to detach the data source from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DetachDataSourceResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "dataSourceArn": { "target": "com.amazonaws.opensearch#ARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DiffCount": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.opensearch#DiffFieldPath": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 } } }, "com.amazonaws.opensearch#DiffFieldPolicy": { "type": "enum", "members": { "REDACTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "redacted" } } } }, "com.amazonaws.opensearch#DiffFieldValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 10240 } } }, "com.amazonaws.opensearch#DiffItemName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.opensearch#DiffItemNameList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DiffItemName" }, "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.opensearch#DiffItems": { "type": "structure", "members": { "SourceOnly": { "target": "com.amazonaws.opensearch#DiffItemNameList", "traits": { "smithy.api#documentation": "

The names of items that exist only on the source domain.

" } }, "TargetOnly": { "target": "com.amazonaws.opensearch#DiffItemNameList", "traits": { "smithy.api#documentation": "

The names of items that exist only on the target domain.

" } }, "Diverged": { "target": "com.amazonaws.opensearch#DivergentItemList", "traits": { "smithy.api#documentation": "

The items that exist on both domains but differ, with the diverging fields.

" } } }, "traits": { "smithy.api#documentation": "

The items that differ within one metadata category.

" } }, "com.amazonaws.opensearch#DiffStatus": { "type": "enum", "members": { "COMPARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "compared" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "error" } } } }, "com.amazonaws.opensearch#DirectQueryDataSource": { "type": "structure", "members": { "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch\n Service environment.

" } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { "smithy.api#documentation": "

The supported Amazon Web Services service that is used as the source for direct\n queries in OpenSearch Service.

" } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { "smithy.api#documentation": "

A description that provides additional context and details about the data\n source.

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are\n associated with the direct query data source.

" } }, "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" } }, "TagList": { "target": "com.amazonaws.opensearch#TagList", "traits": { "smithy.api#documentation": "

A list of tags attached to a direct query data source.

" } } }, "traits": { "smithy.api#documentation": "

The configuration details for a data source that can be directly queried.

" } }, "com.amazonaws.opensearch#DirectQueryDataSourceDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" } }, "com.amazonaws.opensearch#DirectQueryDataSourceList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DirectQueryDataSource" } }, "com.amazonaws.opensearch#DirectQueryDataSourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 80 }, "smithy.api#pattern": "^[a-z][a-z0-9_]+$" } }, "com.amazonaws.opensearch#DirectQueryDataSourceRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 200 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:iam::\\d{12}:role(\\/service-role)?\\/[A-Za-z0-9+=,.@\\-_]{1,64}$" } }, "com.amazonaws.opensearch#DirectQueryDataSourceType": { "type": "union", "members": { "CloudWatchLog": { "target": "com.amazonaws.opensearch#CloudWatchDirectQueryDataSource", "traits": { "smithy.api#documentation": "

Specifies CloudWatch Logs as a type of data source for direct queries.

" } }, "SecurityLake": { "target": "com.amazonaws.opensearch#SecurityLakeDirectQueryDataSource", "traits": { "smithy.api#documentation": "

Specifies Security Lake as a type of data source for direct queries.

" } }, "Prometheus": { "target": "com.amazonaws.opensearch#PrometheusDirectQueryDataSource", "traits": { "smithy.api#documentation": "

Specifies Prometheus as a type of data source for direct queries.

" } } }, "traits": { "smithy.api#documentation": "

The type of data source that is used for direct queries. This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.

" } }, "com.amazonaws.opensearch#DirectQueryOpenSearchARNList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ARN" } }, "com.amazonaws.opensearch#DisableTimestamp": { "type": "timestamp" }, "com.amazonaws.opensearch#DisabledOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An error occured because the client wanted to access an unsupported operation.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#DissociatePackage": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DissociatePackageRequest" }, "output": { "target": "com.amazonaws.opensearch#DissociatePackageResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes a package from the specified Amazon OpenSearch Service domain. The package\n can't be in use with any OpenSearch index for the dissociation to succeed. The package\n is still available in OpenSearch Service for association later. For more information,\n see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/dissociate/{PackageID}/{DomainName}", "code": 200 } } }, "com.amazonaws.opensearch#DissociatePackageRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

Internal ID of the package to dissociate from the domain. Use\n ListPackagesForDomain to find this value.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain to dissociate the package from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the DissociatePackage\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#DissociatePackageResponse": { "type": "structure", "members": { "DomainPackageDetails": { "target": "com.amazonaws.opensearch#DomainPackageDetails", "traits": { "smithy.api#documentation": "

Information about a package that has been dissociated from the domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by an DissociatePackage\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#DissociatePackages": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#DissociatePackagesRequest" }, "output": { "target": "com.amazonaws.opensearch#DissociatePackagesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Dissociates multiple packages from a domain simultaneously.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/dissociateMultiple", "code": 200 } } }, "com.amazonaws.opensearch#DissociatePackagesRequest": { "type": "structure", "members": { "PackageList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { "smithy.api#documentation": "

A list of package IDs to be dissociated from a domain.

", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#DissociatePackagesResponse": { "type": "structure", "members": { "DomainPackageDetailsList": { "target": "com.amazonaws.opensearch#DomainPackageDetailsList", "traits": { "smithy.api#documentation": "

A list of package details for the packages that were dissociated from the\n domain.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#DivergentField": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.opensearch#DiffFieldPath", "traits": { "smithy.api#documentation": "

The location of the field within the item.

" } }, "SourceValue": { "target": "com.amazonaws.opensearch#DiffFieldValue", "traits": { "smithy.api#documentation": "

The field's value on the source domain.

" } }, "TargetValue": { "target": "com.amazonaws.opensearch#DiffFieldValue", "traits": { "smithy.api#documentation": "

The field's value on the target domain.

" } }, "Policy": { "target": "com.amazonaws.opensearch#DiffFieldPolicy", "traits": { "smithy.api#documentation": "

How the comparison treats this field.

" } } }, "traits": { "smithy.api#documentation": "

A single field that differs between the source and target copies of an item.

" } }, "com.amazonaws.opensearch#DivergentFieldList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DivergentField" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.opensearch#DivergentItem": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#DiffItemName", "traits": { "smithy.api#documentation": "

The name of the item.

" } }, "Fields": { "target": "com.amazonaws.opensearch#DivergentFieldList", "traits": { "smithy.api#documentation": "

The fields of the item that differ.

" } } }, "traits": { "smithy.api#documentation": "

An item that exists on both domains but whose contents differ.

" } }, "com.amazonaws.opensearch#DivergentItemList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DivergentItem" }, "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.opensearch#DomainArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]+:[0-9]+:domain\\/[a-z0-9\\-]+$" } }, "com.amazonaws.opensearch#DomainConfig": { "type": "structure", "members": { "EngineVersion": { "target": "com.amazonaws.opensearch#VersionStatus", "traits": { "smithy.api#documentation": "

The OpenSearch or Elasticsearch version that the domain is running.

" } }, "ClusterConfig": { "target": "com.amazonaws.opensearch#ClusterConfigStatus", "traits": { "smithy.api#documentation": "

Container for the cluster configuration of a the domain.

" } }, "EBSOptions": { "target": "com.amazonaws.opensearch#EBSOptionsStatus", "traits": { "smithy.api#documentation": "

Container for EBS options configured for the domain.

" } }, "AccessPolicies": { "target": "com.amazonaws.opensearch#AccessPoliciesStatus", "traits": { "smithy.api#documentation": "

Specifies the access policies for the domain.

" } }, "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressTypeStatus", "traits": { "smithy.api#documentation": "

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to\n share domain resources across IPv4 and IPv6 address types, and is the recommended\n option. If you set your IP address type to dual stack, you can't change your address\n type later.

" } }, "SnapshotOptions": { "target": "com.amazonaws.opensearch#SnapshotOptionsStatus", "traits": { "smithy.api#documentation": "

DEPRECATED. Container for parameters required to configure automated snapshots of\n domain indexes.

" } }, "VPCOptions": { "target": "com.amazonaws.opensearch#VPCDerivedInfoStatus", "traits": { "smithy.api#documentation": "

The current VPC options for the domain and the status of any updates to their\n configuration.

" } }, "CognitoOptions": { "target": "com.amazonaws.opensearch#CognitoOptionsStatus", "traits": { "smithy.api#documentation": "

Container for Amazon Cognito options for the domain.

" } }, "EncryptionAtRestOptions": { "target": "com.amazonaws.opensearch#EncryptionAtRestOptionsStatus", "traits": { "smithy.api#documentation": "

Key-value pairs to enable encryption at rest.

" } }, "NodeToNodeEncryptionOptions": { "target": "com.amazonaws.opensearch#NodeToNodeEncryptionOptionsStatus", "traits": { "smithy.api#documentation": "

Whether node-to-node encryption is enabled or disabled.

" } }, "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptionsStatus", "traits": { "smithy.api#documentation": "

Key-value pairs to specify advanced configuration options. For more information, see\n Advanced options.

" } }, "LogPublishingOptions": { "target": "com.amazonaws.opensearch#LogPublishingOptionsStatus", "traits": { "smithy.api#documentation": "

Key-value pairs to configure log publishing.

" } }, "DomainEndpointOptions": { "target": "com.amazonaws.opensearch#DomainEndpointOptionsStatus", "traits": { "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" } }, "AdvancedSecurityOptions": { "target": "com.amazonaws.opensearch#AdvancedSecurityOptionsStatus", "traits": { "smithy.api#documentation": "

Container for fine-grained access control settings for the domain.

" } }, "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsStatus", "traits": { "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within\n a domain.

" } }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptionsStatus", "traits": { "smithy.api#documentation": "

Container for Auto-Tune settings for the domain.

" } }, "ChangeProgressDetails": { "target": "com.amazonaws.opensearch#ChangeProgressDetails", "traits": { "smithy.api#documentation": "

Container for information about the progress of an existing configuration\n change.

" } }, "OffPeakWindowOptions": { "target": "com.amazonaws.opensearch#OffPeakWindowOptionsStatus", "traits": { "smithy.api#documentation": "

Container for off-peak window options for the domain.

" } }, "SoftwareUpdateOptions": { "target": "com.amazonaws.opensearch#SoftwareUpdateOptionsStatus", "traits": { "smithy.api#documentation": "

Software update options for the domain.

" } }, "ModifyingProperties": { "target": "com.amazonaws.opensearch#ModifyingPropertiesList", "traits": { "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" } }, "AIMLOptions": { "target": "com.amazonaws.opensearch#AIMLOptionsStatus", "traits": { "smithy.api#documentation": "

Container for parameters required to enable all machine learning features.

" } }, "DeploymentStrategyOptions": { "target": "com.amazonaws.opensearch#DeploymentStrategyOptionsStatus", "traits": { "smithy.api#documentation": "

Specifies DeploymentStrategyOptions for the domain.

" } }, "AutomatedSnapshotPauseOptions": { "target": "com.amazonaws.opensearch#AutomatedSnapshotPauseOptionsStatus", "traits": { "smithy.api#documentation": "

Specifies AutomatedSnapshotPauseOptions for the domain.

" } }, "UseCase": { "target": "com.amazonaws.opensearch#UseCaseStatus", "traits": { "smithy.api#documentation": "

The use case configured for the domain.

" } }, "EngineMode": { "target": "com.amazonaws.opensearch#EngineModeStatus", "traits": { "smithy.api#documentation": "

The engine mode configured for the domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for the configuration of an OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#DomainEndpointOptions": { "type": "structure", "members": { "EnforceHTTPS": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to require that all traffic to the domain arrive over HTTPS.

" } }, "TLSSecurityPolicy": { "target": "com.amazonaws.opensearch#TLSSecurityPolicy", "traits": { "smithy.api#documentation": "

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The\n policy can be one of the following values:

\n " } }, "CustomEndpointEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable a custom endpoint for the domain.

" } }, "CustomEndpoint": { "target": "com.amazonaws.opensearch#DomainNameFqdn", "traits": { "smithy.api#documentation": "

The fully qualified URL for the custom endpoint.

" } }, "CustomEndpointCertificateArn": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

The ARN for your security certificate, managed in Amazon Web Services Certificate\n Manager (ACM).

" } } }, "traits": { "smithy.api#documentation": "

Options to configure a custom endpoint for an OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#DomainEndpointOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#DomainEndpointOptions", "traits": { "smithy.api#documentation": "

Options to configure the endpoint for a domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the endpoint options for a domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configured endpoint options for a domain and their current status.

" } }, "com.amazonaws.opensearch#DomainHealth": { "type": "enum", "members": { "Red": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Red" } }, "Yellow": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Yellow" } }, "Green": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Green" } }, "NotAvailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotAvailable" } } } }, "com.amazonaws.opensearch#DomainId": { "type": "string", "traits": { "smithy.api#documentation": "

Unique identifier for an OpenSearch Service domain.

", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.opensearch#DomainInfo": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain.

" } }, "EngineType": { "target": "com.amazonaws.opensearch#EngineType", "traits": { "smithy.api#documentation": "

The type of search engine that the domain is running.OpenSearch for an\n OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS\n engine.

" } } }, "traits": { "smithy.api#documentation": "

Information about an OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#DomainInfoList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DomainInfo" }, "traits": { "smithy.api#documentation": "

Contains a list of information about a domain.

" } }, "com.amazonaws.opensearch#DomainInformationContainer": { "type": "structure", "members": { "AWSDomainInformation": { "target": "com.amazonaws.opensearch#AWSDomainInformation", "traits": { "smithy.api#documentation": "

Information about an Amazon OpenSearch Service domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for information about an OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#DomainMaintenanceDetails": { "type": "structure", "members": { "MaintenanceId": { "target": "com.amazonaws.opensearch#RequestId", "traits": { "smithy.api#documentation": "

The ID of the requested action.

" } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

" } }, "Action": { "target": "com.amazonaws.opensearch#MaintenanceType", "traits": { "smithy.api#documentation": "

The name of the action.

" } }, "NodeId": { "target": "com.amazonaws.opensearch#NodeId", "traits": { "smithy.api#documentation": "

The ID of the data node.

" } }, "Status": { "target": "com.amazonaws.opensearch#MaintenanceStatus", "traits": { "smithy.api#documentation": "

The status of the action.

" } }, "StatusMessage": { "target": "com.amazonaws.opensearch#MaintenanceStatusMessage", "traits": { "smithy.api#documentation": "

The status message for the action.

" } }, "CreatedAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time at which the action was created.

" } }, "UpdatedAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time at which the action was updated.

" } } }, "traits": { "smithy.api#documentation": "

Container for the domain maintenance details.

" } }, "com.amazonaws.opensearch#DomainMaintenanceList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DomainMaintenanceDetails" } }, "com.amazonaws.opensearch#DomainName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of an OpenSearch Service domain. Domain names are unique across the domains\n owned by an account within an Amazon Web Services Region.

", "smithy.api#length": { "min": 3, "max": 28 }, "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.opensearch#DomainNameFqdn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" } }, "com.amazonaws.opensearch#DomainNameList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DomainName" }, "traits": { "smithy.api#documentation": "

A list of OpenSearch Service domain names.

" } }, "com.amazonaws.opensearch#DomainNodesStatus": { "type": "structure", "members": { "NodeId": { "target": "com.amazonaws.opensearch#NodeId", "traits": { "smithy.api#documentation": "

The ID of the node.

" } }, "NodeType": { "target": "com.amazonaws.opensearch#NodeType", "traits": { "smithy.api#documentation": "

Indicates whether the nodes is a data, master, or UltraWarm node.

" } }, "AvailabilityZone": { "target": "com.amazonaws.opensearch#AvailabilityZone", "traits": { "smithy.api#documentation": "

The Availability Zone of the node.

" } }, "InstanceType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

The instance type information of the node.

" } }, "NodeStatus": { "target": "com.amazonaws.opensearch#NodeStatus", "traits": { "smithy.api#documentation": "

Indicates if the node is active or in standby.

" } }, "StorageType": { "target": "com.amazonaws.opensearch#StorageTypeName", "traits": { "smithy.api#documentation": "

Indicates if the node has EBS or instance storage.

" } }, "StorageVolumeType": { "target": "com.amazonaws.opensearch#VolumeType", "traits": { "smithy.api#documentation": "

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only\n applicable for data nodes.

" } }, "StorageSize": { "target": "com.amazonaws.opensearch#VolumeSize", "traits": { "smithy.api#documentation": "

The storage size of the node, in GiB.

" } } }, "traits": { "smithy.api#documentation": "

Container for information about nodes on the domain.

" } }, "com.amazonaws.opensearch#DomainNodesStatusList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DomainNodesStatus" }, "traits": { "smithy.api#documentation": "

List of DomainNodesStatus with details about nodes on the requested\n domain.

" } }, "com.amazonaws.opensearch#DomainPackageDetails": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

Internal ID of the package.

" } }, "PackageName": { "target": "com.amazonaws.opensearch#PackageName", "traits": { "smithy.api#documentation": "

User-specified name of the package.

" } }, "PackageType": { "target": "com.amazonaws.opensearch#PackageType", "traits": { "smithy.api#documentation": "

The type of package.

" } }, "LastUpdated": { "target": "com.amazonaws.opensearch#LastUpdated", "traits": { "smithy.api#documentation": "

Timestamp of the most recent update to the package association status.

" } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain that the package is associated with.

" } }, "DomainPackageStatus": { "target": "com.amazonaws.opensearch#DomainPackageStatus", "traits": { "smithy.api#documentation": "

State of the association.

" } }, "PackageVersion": { "target": "com.amazonaws.opensearch#PackageVersion", "traits": { "smithy.api#documentation": "

The current version of the package.

" } }, "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before or with the\n package can be associated.

" } }, "ReferencePath": { "target": "com.amazonaws.opensearch#ReferencePath", "traits": { "smithy.api#documentation": "

The relative path of the package on the OpenSearch Service cluster nodes. This is\n synonym_path when the package is for synonym files.

" } }, "ErrorDetails": { "target": "com.amazonaws.opensearch#ErrorDetails", "traits": { "smithy.api#documentation": "

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

" } }, "AssociationConfiguration": { "target": "com.amazonaws.opensearch#PackageAssociationConfiguration", "traits": { "smithy.api#documentation": "

The configuration for associating a package with an Amazon OpenSearch Service\n domain.

" } } }, "traits": { "smithy.api#documentation": "

Information about a package that is associated with a domain. For more information,\n see Custom packages\n for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#DomainPackageDetailsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DomainPackageDetails" } }, "com.amazonaws.opensearch#DomainPackageStatus": { "type": "enum", "members": { "ASSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATING" } }, "ASSOCIATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATION_FAILED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DISSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISSOCIATING" } }, "DISSOCIATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISSOCIATION_FAILED" } } } }, "com.amazonaws.opensearch#DomainProcessingStatusType": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Creating" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "MODIFYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Modifying" } }, "UPGRADING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpgradingEngineVersion" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdatingServiceSoftware" } }, "ISOLATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Isolated" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleting" } } } }, "com.amazonaws.opensearch#DomainState": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Processing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Processing" } }, "NotAvailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotAvailable" } } } }, "com.amazonaws.opensearch#DomainStatus": { "type": "structure", "members": { "DomainId": { "target": "com.amazonaws.opensearch#DomainId", "traits": { "smithy.api#documentation": "

Unique identifier for the domain.

", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain. Domain names are unique across all domains owned by the same account\n within an Amazon Web Services Region.

", "smithy.api#required": {} } }, "ARN": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers\n in the Amazon Web Services Identity and Access Management User Guide.

", "smithy.api#required": {} } }, "Created": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Creation status of an OpenSearch Service domain. True if domain creation is complete. False\n if domain creation is still in progress.

" } }, "Deleted": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False\n if domain deletion is still in progress. Once deletion is complete, the status of the domain is\n no longer returned.

" } }, "Endpoint": { "target": "com.amazonaws.opensearch#ServiceUrl", "traits": { "smithy.api#documentation": "

Domain-specific endpoint used to submit index, search, and data upload requests to the\n domain.

" } }, "EndpointV2": { "target": "com.amazonaws.opensearch#ServiceUrl", "traits": { "smithy.api#documentation": "

If IPAddressType to set to dualstack, a version 2 domain endpoint\n is provisioned. This endpoint functions like a normal endpoint, except that it works with both\n IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

" } }, "Endpoints": { "target": "com.amazonaws.opensearch#EndpointsMap", "traits": { "smithy.api#documentation": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For\n example:

\n " } }, "DomainEndpointV2HostedZoneId": { "target": "com.amazonaws.opensearch#HostedZoneId", "traits": { "smithy.api#documentation": "

The dual stack hosted zone ID for the domain.

" } }, "Processing": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

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

" } }, "UpgradeProcessing": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

The status of a domain version upgrade to a new version of OpenSearch or\n Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False\n if the configuration is active.

" } }, "EngineVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

Version of OpenSearch or Elasticsearch that the domain is running, in the format\n Elasticsearch_X.Y or OpenSearch_X.Y.

" } }, "ClusterConfig": { "target": "com.amazonaws.opensearch#ClusterConfig", "traits": { "smithy.api#documentation": "

Container for the cluster configuration of the domain.

", "smithy.api#required": {} } }, "EBSOptions": { "target": "com.amazonaws.opensearch#EBSOptions", "traits": { "smithy.api#documentation": "

Container for EBS-based storage settings for the domain.

" } }, "AccessPolicies": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

Identity and Access Management (IAM) policy document specifying the access policies for the\n domain.

" } }, "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressType", "traits": { "smithy.api#documentation": "

The type of IP addresses supported by the endpoint for the domain.

" } }, "SnapshotOptions": { "target": "com.amazonaws.opensearch#SnapshotOptions", "traits": { "smithy.api#documentation": "

DEPRECATED. Container for parameters required to configure automated snapshots of\n domain indexes.

" } }, "VPCOptions": { "target": "com.amazonaws.opensearch#VPCDerivedInfo", "traits": { "smithy.api#documentation": "

The VPC configuration for the domain.

" } }, "CognitoOptions": { "target": "com.amazonaws.opensearch#CognitoOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

" } }, "EncryptionAtRestOptions": { "target": "com.amazonaws.opensearch#EncryptionAtRestOptions", "traits": { "smithy.api#documentation": "

Encryption at rest settings for the domain.

" } }, "NodeToNodeEncryptionOptions": { "target": "com.amazonaws.opensearch#NodeToNodeEncryptionOptions", "traits": { "smithy.api#documentation": "

Whether node-to-node encryption is enabled or disabled.

" } }, "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { "smithy.api#documentation": "

Key-value pairs that specify advanced configuration options.

" } }, "LogPublishingOptions": { "target": "com.amazonaws.opensearch#LogPublishingOptions", "traits": { "smithy.api#documentation": "

Log publishing options for the domain.

" } }, "ServiceSoftwareOptions": { "target": "com.amazonaws.opensearch#ServiceSoftwareOptions", "traits": { "smithy.api#documentation": "

The current status of the domain's service software.

" } }, "DomainEndpointOptions": { "target": "com.amazonaws.opensearch#DomainEndpointOptions", "traits": { "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" } }, "AdvancedSecurityOptions": { "target": "com.amazonaws.opensearch#AdvancedSecurityOptions", "traits": { "smithy.api#documentation": "

Settings for fine-grained access control.

" } }, "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptions", "traits": { "smithy.api#documentation": "

Configuration options for controlling IAM Identity Center integration within a\n domain.

" } }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptionsOutput", "traits": { "smithy.api#documentation": "

Auto-Tune settings for the domain.

" } }, "ChangeProgressDetails": { "target": "com.amazonaws.opensearch#ChangeProgressDetails", "traits": { "smithy.api#documentation": "

Information about a configuration change happening on the domain.

" } }, "OffPeakWindowOptions": { "target": "com.amazonaws.opensearch#OffPeakWindowOptions", "traits": { "smithy.api#documentation": "

Options that specify a custom 10-hour window during which OpenSearch Service can perform\n configuration changes on the domain.

" } }, "SoftwareUpdateOptions": { "target": "com.amazonaws.opensearch#SoftwareUpdateOptions", "traits": { "smithy.api#documentation": "

Service software update options for the domain.

" } }, "DomainProcessingStatus": { "target": "com.amazonaws.opensearch#DomainProcessingStatusType", "traits": { "smithy.api#documentation": "

The status of any changes that are currently in progress for the domain.

" } }, "ModifyingProperties": { "target": "com.amazonaws.opensearch#ModifyingPropertiesList", "traits": { "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" } }, "AIMLOptions": { "target": "com.amazonaws.opensearch#AIMLOptionsOutput", "traits": { "smithy.api#documentation": "

Container for parameters required to enable all machine learning features.

" } }, "DeploymentStrategyOptions": { "target": "com.amazonaws.opensearch#DeploymentStrategyOptions", "traits": { "smithy.api#documentation": "

The current status of the domain's deployment strategy options.

" } }, "AutomatedSnapshotPauseOptions": { "target": "com.amazonaws.opensearch#AutomatedSnapshotPauseOptions", "traits": { "smithy.api#documentation": "

The current status of the domain's automated snapshot pause options.

" } }, "UseCase": { "target": "com.amazonaws.opensearch#DomainUseCase", "traits": { "smithy.api#documentation": "

The primary use case for the domain.

" } }, "EngineMode": { "target": "com.amazonaws.opensearch#EngineMode", "traits": { "smithy.api#documentation": "

The engine mode for the domain.

" } } }, "traits": { "smithy.api#documentation": "

The current status of an OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#DomainStatusList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#DomainStatus" }, "traits": { "smithy.api#documentation": "

List that contains the status of each specified OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#DomainUseCase": { "type": "enum", "members": { "SEARCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEARCH" } }, "VECTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VECTOR" } }, "OBSERVABILITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OBSERVABILITY" } }, "MIXED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIXED" } } }, "traits": { "smithy.api#documentation": "

The primary use case for the domain, which determines the default configuration and the\n engine modes that are available. Valid values are SEARCH (full-text search,\n e-commerce, content discovery, and hybrid and semantic search), VECTOR (k-NN\n and semantic search, and retrieval-augmented generation), OBSERVABILITY (logs,\n metrics, traces, and dashboards), and MIXED (a combination of search and\n analytics). If you don't specify a use case, MIXED is used.

" } }, "com.amazonaws.opensearch#Double": { "type": "double" }, "com.amazonaws.opensearch#DryRun": { "type": "boolean" }, "com.amazonaws.opensearch#DryRunMode": { "type": "enum", "members": { "Basic": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Basic" } }, "Verbose": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Verbose" } } } }, "com.amazonaws.opensearch#DryRunProgressStatus": { "type": "structure", "members": { "DryRunId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier of the dry run.

", "smithy.api#required": {} } }, "DryRunStatus": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current status of the dry run.

", "smithy.api#required": {} } }, "CreationDate": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The timestamp when the dry run was initiated.

", "smithy.api#required": {} } }, "UpdateDate": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The timestamp when the dry run was last updated.

", "smithy.api#required": {} } }, "ValidationFailures": { "target": "com.amazonaws.opensearch#ValidationFailures", "traits": { "smithy.api#documentation": "

The validation failures that occurred as a result of the dry run.

" } }, "AcceptedWarnings": { "target": "com.amazonaws.opensearch#AcceptedWarningsList", "traits": { "smithy.api#documentation": "

The list of advisory warning codes that were accepted for the configuration change.

" } } }, "traits": { "smithy.api#documentation": "

Information about the progress of a pre-upgrade dry run analysis.

" } }, "com.amazonaws.opensearch#DryRunResults": { "type": "structure", "members": { "DeploymentType": { "target": "com.amazonaws.opensearch#DeploymentType", "traits": { "smithy.api#documentation": "

Specifies the way in which OpenSearch Service will apply an update. Possible values\n are:

\n " } }, "Message": { "target": "com.amazonaws.opensearch#Message", "traits": { "smithy.api#documentation": "

A message corresponding to the deployment type.

" } } }, "traits": { "smithy.api#documentation": "

Results of a dry run performed in an update domain request.

" } }, "com.amazonaws.opensearch#Duration": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.opensearch#DurationValue", "traits": { "smithy.api#documentation": "

Integer to specify the value of a maintenance schedule duration.

" } }, "Unit": { "target": "com.amazonaws.opensearch#TimeUnit", "traits": { "smithy.api#documentation": "

The unit of measurement for the duration of a maintenance schedule.

" } } }, "traits": { "smithy.api#documentation": "

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#DurationValue": { "type": "long", "traits": { "smithy.api#documentation": "

Integer that specifies the value of a maintenance schedule duration.

", "smithy.api#range": { "min": 1, "max": 24 } } }, "com.amazonaws.opensearch#EBSOptions": { "type": "structure", "members": { "EBSEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service\n domain.

" } }, "VolumeType": { "target": "com.amazonaws.opensearch#VolumeType", "traits": { "smithy.api#documentation": "

Specifies the type of EBS volumes attached to data nodes.

" } }, "VolumeSize": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

Specifies the size (in GiB) of EBS volumes attached to data nodes.

" } }, "Iops": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data\n nodes. Applicable only for the gp3 and provisioned IOPS EBS volume\n types.

" } }, "Throughput": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.\n Applicable only for the gp3 volume type.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters required to enable EBS-based storage for an OpenSearch\n Service domain.

" } }, "com.amazonaws.opensearch#EBSOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#EBSOptions", "traits": { "smithy.api#documentation": "

The configured EBS options for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the EBS options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of the EBS options for the specified OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#EncryptionAtRestOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable encryption at rest.

" } }, "KmsKeyId": { "target": "com.amazonaws.opensearch#KmsKeyId", "traits": { "smithy.api#documentation": "

The KMS key ID. Takes the form\n 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" } }, "EncryptionMode": { "target": "com.amazonaws.opensearch#EncryptionMode", "traits": { "smithy.api#documentation": "

The type of encryption at rest applied to the domain's data. Valid values are\n DISK and NATIVE. DISK is the default and uses\n volume-level encryption. NATIVE uses engine-native, index-level encryption\n and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After\n the mode is set to NATIVE, it can't be changed back to\n DISK.

" } } }, "traits": { "smithy.api#documentation": "

Specifies whether the domain should encrypt data at rest, and if so, the Key\n Management Service (KMS) key to use. Can only be used when creating a new domain or\n enabling encryption at rest for the first time on an existing domain. You can't modify\n this parameter after it's already been specified.

" } }, "com.amazonaws.opensearch#EncryptionAtRestOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#EncryptionAtRestOptions", "traits": { "smithy.api#documentation": "

Encryption at rest options for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the encryption at rest options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Status of the encryption at rest options for the specified OpenSearch Service\n domain.

" } }, "com.amazonaws.opensearch#EncryptionMode": { "type": "enum", "members": { "Disk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISK" } }, "Native": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NATIVE" } } }, "traits": { "smithy.api#documentation": "

The type of encryption at rest applied to a domain's data: DISK for\n volume-level encryption or NATIVE for engine-native, index-level\n encryption.

" } }, "com.amazonaws.opensearch#Endpoint": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z0-9\\-\\.]+$" } }, "com.amazonaws.opensearch#EndpointsMap": { "type": "map", "key": { "target": "com.amazonaws.opensearch#String" }, "value": { "target": "com.amazonaws.opensearch#ServiceUrl" } }, "com.amazonaws.opensearch#EngineMode": { "type": "enum", "members": { "GENERAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GENERAL" } }, "OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPTIMIZED" } } }, "traits": { "smithy.api#documentation": "

The engine mode for the domain. Valid values are GENERAL (the standard\n OpenSearch engine) and OPTIMIZED. If you don't specify an engine mode,\n GENERAL is used. OPTIMIZED requires OpenSearch 3.5 or later,\n OpenSearch Optimized instance types (OR1, OR2, OM2, or OI2) for the data tier,\n and is available only for the OBSERVABILITY use cases. The engine mode\n can't be changed after the domain is created.

" } }, "com.amazonaws.opensearch#EngineModeStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#EngineMode", "traits": { "smithy.api#documentation": "

The engine mode configured for the domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The current status of the engine mode for the domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of the engine mode for the domain.

" } }, "com.amazonaws.opensearch#EngineType": { "type": "enum", "members": { "OpenSearch": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpenSearch" } }, "Elasticsearch": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Elasticsearch" } } } }, "com.amazonaws.opensearch#EngineVersion": { "type": "string", "traits": { "smithy.api#pattern": "^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$" } }, "com.amazonaws.opensearch#EnvironmentInfo": { "type": "structure", "members": { "AvailabilityZoneInformation": { "target": "com.amazonaws.opensearch#AvailabilityZoneInfoList", "traits": { "smithy.api#documentation": "

A list of AvailabilityZoneInfo for the domain.

" } } }, "traits": { "smithy.api#documentation": "

Information about the active domain environment.

" } }, "com.amazonaws.opensearch#EnvironmentInfoList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#EnvironmentInfo" } }, "com.amazonaws.opensearch#ErrorDetails": { "type": "structure", "members": { "ErrorType": { "target": "com.amazonaws.opensearch#ErrorType", "traits": { "smithy.api#documentation": "

The type of error that occurred.

" } }, "ErrorMessage": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A message describing the error.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#ErrorMessage": { "type": "string" }, "com.amazonaws.opensearch#ErrorType": { "type": "string" }, "com.amazonaws.opensearch#ExportOptions": { "type": "structure", "members": { "types": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

A list of saved object types to include in the migration. Valid values include dashboard, visualization, index-pattern, search, and query.

" } }, "objects": { "target": "com.amazonaws.opensearch#SavedObjectIdentifierList", "traits": { "smithy.api#documentation": "

A list of specific saved objects to include in the migration, identified by type and ID.

" } }, "includeReferencesDeep": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to include all objects referenced by the exported objects, recursively.

" } } }, "traits": { "smithy.api#documentation": "

Options to filter the scope of saved objects to export during a migration.

" } }, "com.amazonaws.opensearch#FailoverReplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#FailoverReplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#FailoverReplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Promotes a secondary domain to primary without coordinating with the current primary. Use\n this operation when the primary is unreachable and you cannot wait for it to recover.

\n

Writes that had not yet replicated when the primary became unreachable are lost. You must\n set AllowDataLoss to acknowledge this. To promote a domain without losing writes,\n use the SwitchoverReplication operation instead.

\n

Call this operation in the Region of the domain you want to promote.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/replication/failover", "code": 200 } } }, "com.amazonaws.opensearch#FailoverReplicationRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PeerDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the relationship's current primary. The request is\n rejected if this domain is no longer the peer of the domain you are calling.

", "smithy.api#required": {} } }, "AllowDataLoss": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Acknowledges that writes which had not yet replicated are lost. You must set this to\n true; the request is rejected otherwise.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#FailoverReplicationResponse": { "type": "structure", "members": { "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain being promoted.

" } }, "Status": { "target": "com.amazonaws.opensearch#ReplicationStatus", "traits": { "smithy.api#documentation": "

The state of the replication relationship. This is FAILING_OVER while the\n promotion is in progress.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#Filter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the filter.

" } }, "Values": { "target": "com.amazonaws.opensearch#ValueStringList", "traits": { "smithy.api#documentation": "

One or more values for the filter.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#FilterList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#Filter" } }, "com.amazonaws.opensearch#GUID": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}$" } }, "com.amazonaws.opensearch#GUIDList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#GUID" } }, "com.amazonaws.opensearch#GetApplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetApplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#GetApplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the configuration and status of an existing OpenSearch application.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/application/{id}", "code": 200 } } }, "com.amazonaws.opensearch#GetApplicationRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetApplicationResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the OpenSearch application.

" } }, "endpoint": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The endpoint URL of the OpenSearch application.

" } }, "status": { "target": "com.amazonaws.opensearch#ApplicationStatus", "traits": { "smithy.api#documentation": "

The current status of the OpenSearch application. Possible values: CREATING,\n UPDATING, DELETING, FAILED, ACTIVE, and\n DELETED.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", "traits": { "smithy.api#documentation": "

The IAM Identity Center settings configured for the OpenSearch application.

" } }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { "smithy.api#documentation": "

The data sources associated with the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { "smithy.api#documentation": "

The configuration settings of the OpenSearch application.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the OpenSearch application was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp of the last update to the OpenSearch application.

" } }, "kmsKeyArn": { "target": "com.amazonaws.opensearch#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetCapability": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetCapabilityRequest" }, "output": { "target": "com.amazonaws.opensearch#GetCapabilityResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/application/{applicationId}/capability/{capabilityName}", "code": 200 } } }, "com.amazonaws.opensearch#GetCapabilityRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch UI application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "capabilityName": { "target": "com.amazonaws.opensearch#CapabilityName", "traits": { "smithy.api#documentation": "

The name of the capability to retrieve information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the GetCapability operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetCapabilityResponse": { "type": "structure", "members": { "capabilityName": { "target": "com.amazonaws.opensearch#CapabilityName", "traits": { "smithy.api#documentation": "

The name of the capability.

" } }, "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch UI application.

" } }, "status": { "target": "com.amazonaws.opensearch#CapabilityStatus", "traits": { "smithy.api#documentation": "

The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

" } }, "capabilityConfig": { "target": "com.amazonaws.opensearch#CapabilityExtendedResponseConfig", "traits": { "smithy.api#documentation": "

The configuration settings for the capability, including capability-specific settings such as AI configuration.

" } }, "failures": { "target": "com.amazonaws.opensearch#CapabilityFailures", "traits": { "smithy.api#documentation": "

A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

" } } }, "traits": { "smithy.api#documentation": "

The result of a GetCapability request. Contains details about the capability.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetCompatibleVersions": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetCompatibleVersionsRequest" }, "output": { "target": "com.amazonaws.opensearch#GetCompatibleVersionsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade\n them to.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/compatibleVersions", "code": 200 } } }, "com.amazonaws.opensearch#GetCompatibleVersionsRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of an existing domain. Provide this parameter to limit the results to a single\n domain.

", "smithy.api#httpQuery": "domainName" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to GetCompatibleVersions operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetCompatibleVersionsResponse": { "type": "structure", "members": { "CompatibleVersions": { "target": "com.amazonaws.opensearch#CompatibleVersionsList", "traits": { "smithy.api#documentation": "

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them\n to.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the GetCompatibleVersions\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#GetDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about a direct query data source.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", "code": 200 } } }, "com.amazonaws.opensearch#GetDataSourceRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { "smithy.api#documentation": "

The name of the data source to get information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the GetDataSource operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetDataSourceResponse": { "type": "structure", "members": { "DataSourceType": { "target": "com.amazonaws.opensearch#DataSourceType", "traits": { "smithy.api#documentation": "

The type of data source.

" } }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { "smithy.api#documentation": "

The name of the data source.

" } }, "Description": { "target": "com.amazonaws.opensearch#DataSourceDescription", "traits": { "smithy.api#documentation": "

A description of the data source.

" } }, "Status": { "target": "com.amazonaws.opensearch#DataSourceStatus", "traits": { "smithy.api#documentation": "

The status of the data source.

" } } }, "traits": { "smithy.api#documentation": "

The result of a GetDataSource operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetDefaultApplicationSetting": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetDefaultApplicationSettingRequest" }, "output": { "target": "com.amazonaws.opensearch#GetDefaultApplicationSettingResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets the ARN of the current default application.

\n

If the default application isn't set, the operation returns a resource not found\n error.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/defaultApplicationSetting", "code": 200 } } }, "com.amazonaws.opensearch#GetDefaultApplicationSettingRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetDefaultApplicationSettingResponse": { "type": "structure", "members": { "applicationArn": { "target": "com.amazonaws.opensearch#ARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetDirectQueryDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetDirectQueryDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#GetDirectQueryDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns detailed configuration information for a specific direct query data source in\n Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/directQueryDataSource/{DataSourceName}", "code": 200 } } }, "com.amazonaws.opensearch#GetDirectQueryDataSourceRequest": { "type": "structure", "members": { "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { "smithy.api#documentation": "

A unique, user-defined label that identifies the data source within your OpenSearch Service\n environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetDirectQueryDataSourceResponse": { "type": "structure", "members": { "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch Service\n environment.

" } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { "smithy.api#documentation": "

The supported Amazon Web Services service that is used as the source for direct queries in\n OpenSearch Service.

" } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { "smithy.api#documentation": "

A description that provides additional context and details about the data source.

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated\n with the direct query data source.

" } }, "DataSourceAccessPolicy": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

The IAM access policy document that defines the permissions for accessing the direct query data source. Returns the current policy configuration in JSON format, or null if no custom policy is configured.

" } }, "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetDomainMaintenanceStatus": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetDomainMaintenanceStatusRequest" }, "output": { "target": "com.amazonaws.opensearch#GetDomainMaintenanceStatusResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

The status of the maintenance action.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance", "code": 200 } } }, "com.amazonaws.opensearch#GetDomainMaintenanceStatusRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaintenanceId": { "target": "com.amazonaws.opensearch#RequestId", "traits": { "smithy.api#documentation": "

The request ID of the maintenance action.

", "smithy.api#httpQuery": "maintenanceId", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the GetDomainMaintenanceStatus\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetDomainMaintenanceStatusResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.opensearch#MaintenanceStatus", "traits": { "smithy.api#documentation": "

The status of the maintenance action.

" } }, "StatusMessage": { "target": "com.amazonaws.opensearch#MaintenanceStatusMessage", "traits": { "smithy.api#documentation": "

The status message of the maintenance action.

" } }, "NodeId": { "target": "com.amazonaws.opensearch#NodeId", "traits": { "smithy.api#documentation": "

The node ID of the maintenance action.

" } }, "Action": { "target": "com.amazonaws.opensearch#MaintenanceType", "traits": { "smithy.api#documentation": "

The action name.

" } }, "CreatedAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time at which the action was created.

" } }, "UpdatedAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The time at which the action was updated.

" } } }, "traits": { "smithy.api#documentation": "

The result of a GetDomainMaintenanceStatus request that information about the\n requested action.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetIndexRequest" }, "output": { "target": "com.amazonaws.opensearch#GetIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ThrottlingException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}", "code": 200 } } }, "com.amazonaws.opensearch#GetIndexRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IndexName": { "target": "com.amazonaws.opensearch#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to retrieve information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetIndexResponse": { "type": "structure", "members": { "IndexSchema": { "target": "com.amazonaws.opensearch#IndexSchema", "traits": { "smithy.api#documentation": "

The JSON schema of the index including mappings, settings, and semantic enrichment configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetMigration": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetMigrationRequest" }, "output": { "target": "com.amazonaws.opensearch#GetMigrationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the current status and progress of a migration job, including the number of exported and imported objects and error details if the migration failed.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/app-migrations/{migrationId}", "code": 200 } } }, "com.amazonaws.opensearch#GetMigrationRequest": { "type": "structure", "members": { "migrationId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the migration job to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetMigrationResponse": { "type": "structure", "members": { "migrationId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the migration job.

" } }, "status": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current status of the migration job. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED.

" } }, "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application associated with the migration.

" } }, "source": { "target": "com.amazonaws.opensearch#MigrationSource", "traits": { "smithy.api#documentation": "

The source configuration for the migration, including the data source ARN.

" } }, "exportedCount": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of saved objects exported from the source data source.

" } }, "importedCount": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of saved objects successfully imported into the target workspace.

" } }, "error": { "target": "com.amazonaws.opensearch#MigrationError", "traits": { "smithy.api#documentation": "

Error details if the migration failed or completed with errors.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the migration job was created.

" } }, "updatedAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the migration job was last updated.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetPackageVersionHistory": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetPackageVersionHistoryRequest" }, "output": { "target": "com.amazonaws.opensearch#GetPackageVersionHistoryResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of Amazon OpenSearch Service package versions, along with their creation\n time, commit message, and plugin properties (if the package is a zip plugin package). For more\n information, see Custom packages for Amazon\n OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/packages/{PackageID}/history", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#GetPackageVersionHistoryRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

The unique identifier of the package.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the GetPackageVersionHistory\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetPackageVersionHistoryResponse": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

The unique identifier of the package.

" } }, "PackageVersionHistoryList": { "target": "com.amazonaws.opensearch#PackageVersionHistoryList", "traits": { "smithy.api#documentation": "

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

" } }, "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Container for response returned by GetPackageVersionHistory operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetUpgradeHistory": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetUpgradeHistoryRequest" }, "output": { "target": "com.amazonaws.opensearch#GetUpgradeHistoryResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch\n Service domain.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/upgradeDomain/{DomainName}/history", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#GetUpgradeHistoryRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of an existing domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the GetUpgradeHistory operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetUpgradeHistoryResponse": { "type": "structure", "members": { "UpgradeHistories": { "target": "com.amazonaws.opensearch#UpgradeHistoryList", "traits": { "smithy.api#documentation": "

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a\n domain.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the GetUpgradeHistory operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#GetUpgradeStatus": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#GetUpgradeStatusRequest" }, "output": { "target": "com.amazonaws.opensearch#GetUpgradeStatusResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the most recent status of the last upgrade or upgrade eligibility check performed on\n an Amazon OpenSearch Service domain.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/upgradeDomain/{DomainName}/status", "code": 200 } } }, "com.amazonaws.opensearch#GetUpgradeStatusRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The domain of the domain to get upgrade status information for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the GetUpgradeStatus operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#GetUpgradeStatusResponse": { "type": "structure", "members": { "UpgradeStep": { "target": "com.amazonaws.opensearch#UpgradeStep", "traits": { "smithy.api#documentation": "

One of three steps that an upgrade or upgrade eligibility check goes through.

" } }, "StepStatus": { "target": "com.amazonaws.opensearch#UpgradeStatus", "traits": { "smithy.api#documentation": "

The status of the current step that an upgrade is on.

" } }, "UpgradeName": { "target": "com.amazonaws.opensearch#UpgradeName", "traits": { "smithy.api#documentation": "

A string that describes the update.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the GetUpgradeStatus operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#HostedZoneId": { "type": "string" }, "com.amazonaws.opensearch#IAMFederationOptionsInput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether IAM identity federation is enabled for the OpenSearch domain.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#IAMFederationSubjectKey", "traits": { "smithy.api#documentation": "

The key in the SAML assertion that contains the user's subject identifier.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#IAMFederationRolesKey", "traits": { "smithy.api#documentation": "

The key in the SAML assertion that contains the user's role information.

" } } }, "traits": { "smithy.api#documentation": "

Input parameters for configuring IAM identity federation settings.

" } }, "com.amazonaws.opensearch#IAMFederationOptionsOutput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether IAM identity federation is currently enabled for the domain.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#IAMFederationSubjectKey", "traits": { "smithy.api#documentation": "

The configured key in the SAML assertion for the user's subject identifier.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#IAMFederationRolesKey", "traits": { "smithy.api#documentation": "

The configured key in the SAML assertion for the user's role information.

" } } }, "traits": { "smithy.api#documentation": "

Output parameters showing the current IAM identity federation configuration.

" } }, "com.amazonaws.opensearch#IAMFederationRolesKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^(null|[A-Za-z][A-Za-z0-9_.:/=+\\-@]*)$" } }, "com.amazonaws.opensearch#IAMFederationSubjectKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^(null|[A-Za-z][A-Za-z0-9_.:/=+\\-@]*)$" } }, "com.amazonaws.opensearch#IPAddressType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack" } } } }, "com.amazonaws.opensearch#IPAddressTypeStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#IPAddressType", "traits": { "smithy.api#documentation": "

The IP address options for the domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The IP address type status for the domain.

" } }, "com.amazonaws.opensearch#IamIdentityCenterOptions": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for the OpenSearch application.

" } }, "iamIdentityCenterInstanceArn": { "target": "com.amazonaws.opensearch#ARN" }, "iamRoleForIdentityCenterApplicationArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center\n application for the OpenSearch application.

" } }, "iamIdentityCenterApplicationArn": { "target": "com.amazonaws.opensearch#ARN" } }, "traits": { "smithy.api#documentation": "

Configuration settings for IAM Identity Center in an OpenSearch application.

" } }, "com.amazonaws.opensearch#IamIdentityCenterOptionsInput": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether IAM Identity Center is enabled or disabled.

" } }, "iamIdentityCenterInstanceArn": { "target": "com.amazonaws.opensearch#ARN" }, "iamRoleForIdentityCenterApplicationArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role associated with the IAM Identity Center application.

" } } }, "traits": { "smithy.api#documentation": "

Configuration settings for enabling and managing IAM Identity Center.

" } }, "com.amazonaws.opensearch#Id": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9]{3,30}$" } }, "com.amazonaws.opensearch#IdentityCenterApplicationARN": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+$" } }, "com.amazonaws.opensearch#IdentityCenterInstanceARN": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+$" } }, "com.amazonaws.opensearch#IdentityCenterOptions": { "type": "structure", "members": { "EnabledAPIAccess": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for the application.

" } }, "IdentityCenterInstanceARN": { "target": "com.amazonaws.opensearch#IdentityCenterInstanceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

" } }, "IdentityCenterInstanceRegion": { "target": "com.amazonaws.opensearch#Region", "traits": { "smithy.api#documentation": "

The Region of the IAM Identity Center instance.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or\n email) in IAM Identity Center.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or\n group ID) in IAM Identity Center.

" } }, "IdentityCenterApplicationARN": { "target": "com.amazonaws.opensearch#IdentityCenterApplicationARN", "traits": { "smithy.api#documentation": "

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch\n Service.

" } }, "IdentityStoreId": { "target": "com.amazonaws.opensearch#IdentityStoreId", "traits": { "smithy.api#documentation": "

The identifier of the IAM Identity Store.

" } } }, "traits": { "smithy.api#documentation": "

Settings container for integrating IAM Identity Center with OpenSearch UI applications,\n which enables enabling secure user authentication and access control across multiple data\n sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing\n centralized user management.

" } }, "com.amazonaws.opensearch#IdentityCenterOptionsInput": { "type": "structure", "members": { "EnabledAPIAccess": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch\n Service.

" } }, "IdentityCenterInstanceARN": { "target": "com.amazonaws.opensearch#IdentityCenterInstanceARN", "traits": { "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that\n uses IAM Identity Center for authentication.

" } }, "IdentityCenterInstanceRegion": { "target": "com.amazonaws.opensearch#Region", "traits": { "smithy.api#documentation": "

The Region of the IAM Identity Center instance.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or\n email) in IAM Identity Center.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or\n group ID) in IAM Identity Center.

" } } }, "traits": { "smithy.api#documentation": "

Configuration settings for enabling and managing IAM Identity Center.

" } }, "com.amazonaws.opensearch#IdentityCenterOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#IdentityCenterOptions", "traits": { "smithy.api#documentation": "

Configuration settings for IAM Identity Center integration.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of IAM Identity Center configuration settings for a domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of IAM Identity Center configuration settings for a domain.

" } }, "com.amazonaws.opensearch#IdentityPoolId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 55 }, "smithy.api#pattern": "^[\\w-]+:[0-9a-f-]+$" } }, "com.amazonaws.opensearch#IdentityStoreId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\\\b[0-9a-f]{12}$" } }, "com.amazonaws.opensearch#InboundConnection": { "type": "structure", "members": { "LocalDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Information about the source (local) domain.

" } }, "RemoteDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Information about the destination (remote) domain.

" } }, "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

The unique identifier of the connection.

" } }, "ConnectionStatus": { "target": "com.amazonaws.opensearch#InboundConnectionStatus", "traits": { "smithy.api#documentation": "

The current status of the connection.

" } }, "ConnectionMode": { "target": "com.amazonaws.opensearch#ConnectionMode", "traits": { "smithy.api#documentation": "

The connection mode.

" } } }, "traits": { "smithy.api#documentation": "

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more\n information, see Cross-cluster search\n for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#InboundConnectionStatus": { "type": "structure", "members": { "StatusCode": { "target": "com.amazonaws.opensearch#InboundConnectionStatusCode", "traits": { "smithy.api#documentation": "

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

\n " } }, "Message": { "target": "com.amazonaws.opensearch#ConnectionStatusMessage", "traits": { "smithy.api#documentation": "

Information about the connection.

" } } }, "traits": { "smithy.api#documentation": "

The status of an inbound cross-cluster connection for OpenSearch Service.

" } }, "com.amazonaws.opensearch#InboundConnectionStatusCode": { "type": "enum", "members": { "PENDING_ACCEPTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ACCEPTANCE" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "REJECTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTING" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.opensearch#InboundConnections": { "type": "list", "member": { "target": "com.amazonaws.opensearch#InboundConnection" } }, "com.amazonaws.opensearch#IndexName": { "type": "string", "traits": { "smithy.api#documentation": "Name of OpenSearch index to be created/updated/retrieved/deleted for customer's domain", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?!\\.\\.?$)[^_ ,:\"+/*\\\\|?#>The unique identifier of the insight.

" } }, "DisplayName": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The display name of the insight.

" } }, "Type": { "target": "com.amazonaws.opensearch#InsightType", "traits": { "smithy.api#documentation": "

The type of the insight. Possible values are EVENT and\n RECOMMENDATION.

" } }, "Priority": { "target": "com.amazonaws.opensearch#InsightPriorityLevel", "traits": { "smithy.api#documentation": "

The priority level of the insight. Possible values are CRITICAL,\n HIGH, MEDIUM, and LOW.

" } }, "Status": { "target": "com.amazonaws.opensearch#InsightStatus", "traits": { "smithy.api#documentation": "

The current status of the insight. Possible values are ACTIVE,\n RESOLVED, and DISMISSED.

" } }, "CreationTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when the insight was created, in epoch milliseconds.

" } }, "UpdateTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when the insight was last updated, in epoch milliseconds.

" } }, "IsExperimental": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the insight is experimental.

" } } }, "traits": { "smithy.api#documentation": "

Represents an insight returned by the ListInsights operation. An insight\n is a notification about a domain event or recommendation that helps you optimize your\n Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#InsightEntity": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.opensearch#InsightEntityType", "traits": { "smithy.api#documentation": "

The type of the entity. Possible values are Account and\n DomainName.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.opensearch#InsightEntityValue", "traits": { "smithy.api#documentation": "

The value of the entity. For DomainName, this is the domain name. For\n Account, this is the Amazon Web Services account ID.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the entity for which to retrieve insights. An entity can be an Amazon\n OpenSearch Service domain or an Amazon Web Services account.

" } }, "com.amazonaws.opensearch#InsightEntityType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Account" } }, "DOMAIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DomainName" } } }, "traits": { "smithy.api#documentation": "

The type of entity for which to retrieve insights. Possible values are\n Account and DomainName.

" } }, "com.amazonaws.opensearch#InsightEntityValue": { "type": "string", "traits": { "smithy.api#documentation": "

The value of the entity, such as a domain name or Amazon Web Services account\n ID.

", "smithy.api#length": { "min": 3, "max": 28 }, "smithy.api#pattern": "^([a-z][a-z0-9\\-]+|\\d{12})$" } }, "com.amazonaws.opensearch#InsightFeedback": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#InsightFeedbackRequest" }, "output": { "target": "com.amazonaws.opensearch#InsightFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Submits feedback for an existing insight in an Amazon OpenSearch Service domain.\n Allows users to provide a thumbs up or thumbs down rating and optional text feedback\n for a specific insight.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/insight-feedback", "code": 200 } } }, "com.amazonaws.opensearch#InsightFeedbackEntity": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.opensearch#InsightFeedbackEntityType", "traits": { "smithy.api#documentation": "

The type of the entity. Possible values are DomainName.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.opensearch#InsightEntityValue", "traits": { "smithy.api#documentation": "

The value of the entity, such as a domain name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the entity for which to submit insight feedback. An entity represents an\n Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#InsightFeedbackEntityType": { "type": "enum", "members": { "DOMAIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DomainName" } } }, "traits": { "smithy.api#documentation": "

The type of entity for which to submit insight feedback. Possible values are\n DomainName.

" } }, "com.amazonaws.opensearch#InsightFeedbackRequest": { "type": "structure", "members": { "Entity": { "target": "com.amazonaws.opensearch#InsightFeedbackEntity", "traits": { "smithy.api#documentation": "

The entity for which to submit insight feedback. Specifies the type and value of the\n entity, such as a domain name.

", "smithy.api#required": {} } }, "InsightId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier of the insight for which to submit feedback.

", "smithy.api#required": {} } }, "Thumbs": { "target": "com.amazonaws.opensearch#InsightFeedbackThumbs", "traits": { "smithy.api#documentation": "

The thumbs up or thumbs down feedback for the insight. Possible values are\n Up and Down.

", "smithy.api#required": {} } }, "FeedbackText": { "target": "com.amazonaws.opensearch#InsightFeedbackText", "traits": { "smithy.api#documentation": "

Optional text feedback providing additional details about the insight. Maximum length\n is 1000 characters.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the InsightFeedback operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#InsightFeedbackResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.opensearch#InsightResponseStatus", "traits": { "smithy.api#documentation": "

The status of the feedback submission. Possible values are SUCCESS and\n ERROR.

" } } }, "traits": { "smithy.api#documentation": "

The result of an InsightFeedback request. Contains the status of the\n feedback submission.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#InsightFeedbackText": { "type": "string", "traits": { "smithy.api#documentation": "

Optional text feedback providing additional details about an insight. Maximum length\n is 1000 characters.

", "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.opensearch#InsightFeedbackThumbs": { "type": "enum", "members": { "UP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Up" } }, "DOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Down" } } }, "traits": { "smithy.api#documentation": "

The thumbs up or thumbs down feedback for an insight. Possible values are\n Up and Down.

" } }, "com.amazonaws.opensearch#InsightField": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The name of the insight field.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.opensearch#InsightFieldType", "traits": { "smithy.api#documentation": "

The type of the insight field. Possible values are text and\n metric.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The value of the insight field.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents a field in the detailed view of an insight, returned by the\n DescribeInsightDetails operation.

" } }, "com.amazonaws.opensearch#InsightFieldList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#InsightField" }, "traits": { "smithy.api#documentation": "

A list of insight fields.

" } }, "com.amazonaws.opensearch#InsightFieldType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "text" } }, "METRIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "metric" } } }, "traits": { "smithy.api#documentation": "

The type of an insight field. Possible values are text and\n metric.

" } }, "com.amazonaws.opensearch#InsightList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#Insight" }, "traits": { "smithy.api#documentation": "

A list of insights.

" } }, "com.amazonaws.opensearch#InsightPageSize": { "type": "integer", "traits": { "smithy.api#documentation": "

The maximum number of insights to return per page. Valid values are 1 to 500.

", "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.opensearch#InsightPriorityLevel": { "type": "enum", "members": { "CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRITICAL" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } } }, "traits": { "smithy.api#documentation": "

The priority level of an insight. Possible values are CRITICAL,\n HIGH, MEDIUM, and LOW.

" } }, "com.amazonaws.opensearch#InsightResponseStatus": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } }, "traits": { "smithy.api#documentation": "

The status of an insight response. Possible values are SUCCESS and\n ERROR.

" } }, "com.amazonaws.opensearch#InsightSortOrder": { "type": "enum", "members": { "ASC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASC" } }, "DESC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESC" } } }, "traits": { "smithy.api#documentation": "

The sort order for listing insights. Possible values are ASC (ascending)\n and DESC (descending).

" } }, "com.amazonaws.opensearch#InsightStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "RESOLVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOLVED" } }, "DISMISSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISMISSED" } } }, "traits": { "smithy.api#documentation": "

The status of an insight. Possible values are ACTIVE,\n RESOLVED, and DISMISSED.

" } }, "com.amazonaws.opensearch#InsightTimeRange": { "type": "structure", "members": { "From": { "target": "com.amazonaws.opensearch#Long", "traits": { "smithy.api#documentation": "

The start of the time range, in epoch milliseconds.

", "smithy.api#required": {} } }, "To": { "target": "com.amazonaws.opensearch#Long", "traits": { "smithy.api#documentation": "

The end of the time range, in epoch milliseconds.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the time range for filtering insights.

" } }, "com.amazonaws.opensearch#InsightType": { "type": "enum", "members": { "EVENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EVENT" } }, "RECOMMENDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOMMENDATION" } } }, "traits": { "smithy.api#documentation": "

The type of an insight. Possible values are EVENT and\n RECOMMENDATION.

" } }, "com.amazonaws.opensearch#InstanceCount": { "type": "integer", "traits": { "smithy.api#documentation": "

Number of instances in an OpenSearch Service cluster.

", "smithy.api#range": { "min": 1 } } }, "com.amazonaws.opensearch#InstanceCountLimits": { "type": "structure", "members": { "MinimumInstanceCount": { "target": "com.amazonaws.opensearch#MinimumInstanceCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum allowed number of instances.

" } }, "MaximumInstanceCount": { "target": "com.amazonaws.opensearch#MaximumInstanceCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The minimum allowed number of instances.

" } } }, "traits": { "smithy.api#documentation": "

Limits on the number of instances that can be created in OpenSearch Service for a given\n instance type.

" } }, "com.amazonaws.opensearch#InstanceLimits": { "type": "structure", "members": { "InstanceCountLimits": { "target": "com.amazonaws.opensearch#InstanceCountLimits", "traits": { "smithy.api#documentation": "

Limits on the number of instances that can be created for a given instance type.

" } } }, "traits": { "smithy.api#documentation": "

Instance-related attributes that are available for a given instance type.

" } }, "com.amazonaws.opensearch#InstanceRole": { "type": "string" }, "com.amazonaws.opensearch#InstanceRoleList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#InstanceRole" } }, "com.amazonaws.opensearch#InstanceTypeDetails": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

The instance type.

" } }, "EncryptionEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether encryption at rest and node-to-node encryption are supported for the instance\n type.

" } }, "CognitoEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether Amazon Cognito access is supported for the instance type.

" } }, "AppLogsEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether logging is supported for the instance type.

" } }, "AdvancedSecurityEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether fine-grained access control is supported for the instance type.

" } }, "WarmEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether UltraWarm is supported for the instance type.

" } }, "InstanceRole": { "target": "com.amazonaws.opensearch#InstanceRoleList", "traits": { "smithy.api#documentation": "

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm\n node.

" } }, "AvailabilityZones": { "target": "com.amazonaws.opensearch#AvailabilityZoneList", "traits": { "smithy.api#documentation": "

The supported Availability Zones for the instance type.

" } } }, "traits": { "smithy.api#documentation": "

Lists all instance types and available features for a given OpenSearch or Elasticsearch\n version.

" } }, "com.amazonaws.opensearch#InstanceTypeDetailsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#InstanceTypeDetails" } }, "com.amazonaws.opensearch#InstanceTypeString": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 40 }, "smithy.api#pattern": "^.*\\..*\\.search$" } }, "com.amazonaws.opensearch#Integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.opensearch#IntegerClass": { "type": "integer" }, "com.amazonaws.opensearch#InternalException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

Request processing failed because of an unknown error, exception, or internal failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.opensearch#InvalidPaginationTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

Request processing failed because you provided an invalid pagination token.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.opensearch#InvalidTypeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for trying to create or access a sub-resource that's either invalid or not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#Issue": { "type": "string" }, "com.amazonaws.opensearch#Issues": { "type": "list", "member": { "target": "com.amazonaws.opensearch#Issue" } }, "com.amazonaws.opensearch#JWTOptionsInput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable JWT authentication and authorization for a domain.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKey", "traits": { "smithy.api#documentation": "

Element of the JWT assertion to use for the user name.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKey", "traits": { "smithy.api#documentation": "

Element of the JWT assertion to use for roles.

" } }, "JwksUrl": { "target": "com.amazonaws.opensearch#JwksUrl", "traits": { "smithy.api#documentation": "

The URL endpoint that hosts the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures.

" } }, "PublicKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

Element of the JWT assertion used by the cluster to verify JWT signatures.

" } } }, "traits": { "smithy.api#documentation": "

The JWT authentication and authorization configuration for an Amazon OpenSearch\n Service domain.

" } }, "com.amazonaws.opensearch#JWTOptionsOutput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True if JWT use is enabled.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The key used for matching the JWT subject attribute.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The key used for matching the JWT roles attribute.

" } }, "JwksUrl": { "target": "com.amazonaws.opensearch#JwksUrl", "traits": { "smithy.api#documentation": "

The configured JWKS URL endpoint from which the cluster retrieves public keys to verify JWT requests.

" } }, "PublicKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The key used to verify the signature of incoming JWT requests.

" } } }, "traits": { "smithy.api#documentation": "

Describes the JWT options configured for the domain.

" } }, "com.amazonaws.opensearch#JwksUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^$|^https://(?!(?:10|127|169\\.254|192\\.168|172\\.(?:1[6-9]|2[0-9]|3[01]))\\.)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\\.[a-zA-Z]{2,}(?::[0-9]{1,5})?(?:/[a-zA-Z0-9\\-._~%!$&'()*+,;=:'@]*(?:/[a-zA-Z0-9\\-._~%!$&'()*+,;=:'@]*)*)?(?:\\?[a-zA-Z0-9\\-._~%!$&'()*+,;=:'/@?]+)?$" } }, "com.amazonaws.opensearch#KeyStoreAccessOption": { "type": "structure", "members": { "KeyAccessRoleArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { "smithy.api#documentation": "

Role ARN to access the KeyStore Key

" } }, "KeyStoreAccessEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

This indicates whether Key Store access is enabled

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration parameters to enable access to the key store required by the\n package.

" } }, "com.amazonaws.opensearch#KmsKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.opensearch#KmsKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#LastUpdated": { "type": "timestamp" }, "com.amazonaws.opensearch#LicenseFilepath": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^(?!.*\\/\\.{2,})(?!.*\\.\\.)[a-zA-Z0-9_.-]+(?:\\/[a-zA-Z0-9_.-]+)*$" } }, "com.amazonaws.opensearch#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for trying to create more than the allowed number of resources or sub-resources.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#LimitName": { "type": "string" }, "com.amazonaws.opensearch#LimitValue": { "type": "string" }, "com.amazonaws.opensearch#LimitValueList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#LimitValue" } }, "com.amazonaws.opensearch#Limits": { "type": "structure", "members": { "StorageTypes": { "target": "com.amazonaws.opensearch#StorageTypeList", "traits": { "smithy.api#documentation": "

Storage-related attributes that are available for a given instance type.

" } }, "InstanceLimits": { "target": "com.amazonaws.opensearch#InstanceLimits", "traits": { "smithy.api#documentation": "

The limits for a given instance type.

" } }, "AdditionalLimits": { "target": "com.amazonaws.opensearch#AdditionalLimitList", "traits": { "smithy.api#documentation": "

List of additional limits that are specific to a given instance type for each of its\n instance roles.

" } } }, "traits": { "smithy.api#documentation": "

Limits for a given instance type and for each of its roles.

" } }, "com.amazonaws.opensearch#LimitsByRole": { "type": "map", "key": { "target": "com.amazonaws.opensearch#InstanceRole" }, "value": { "target": "com.amazonaws.opensearch#Limits" }, "traits": { "smithy.api#documentation": "

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

\n " } }, "com.amazonaws.opensearch#ListApplications": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListApplicationsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListApplicationsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all OpenSearch applications under your account.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/list-applications", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "ApplicationSummaries", "pageSize": "maxResults" } } }, "com.amazonaws.opensearch#ListApplicationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#httpQuery": "nextToken" } }, "statuses": { "target": "com.amazonaws.opensearch#ApplicationStatuses", "traits": { "smithy.api#documentation": "

Filters the list of OpenSearch applications by status. Possible values:\n CREATING, UPDATING, DELETING,\n FAILED, ACTIVE, and DELETED.

", "smithy.api#httpQuery": "statuses" } }, "maxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListApplicationsResponse": { "type": "structure", "members": { "ApplicationSummaries": { "target": "com.amazonaws.opensearch#ApplicationSummaries", "traits": { "smithy.api#documentation": "

Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status,\n creation time, and last update time.

" } }, "nextToken": { "target": "com.amazonaws.opensearch#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListDataSourceAttachments": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListDataSourceAttachmentsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListDataSourceAttachmentsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states (PENDING, ATTACHED, and FAILED).

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application/{id}/listDataSourceAttachments", "code": 200 } } }, "com.amazonaws.opensearch#ListDataSourceAttachmentsRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier or name of the OpenSearch application to list attachments for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The pagination token from a previous call to retrieve the next set of results.

" } }, "maxResults": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of results to return per page. The default is 50.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListDataSourceAttachmentsResponse": { "type": "structure", "members": { "attachments": { "target": "com.amazonaws.opensearch#DataSourceAttachmentSummaryList", "traits": { "smithy.api#documentation": "

A list of data source attachment summaries for the specified application.

" } }, "nextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The pagination token to use in a subsequent call to retrieve the next set of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListDataSources": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListDataSourcesRequest" }, "output": { "target": "com.amazonaws.opensearch#ListDataSourcesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists direct-query data sources for a specific domain. For more information, see For\n more information, see Working with\n Amazon OpenSearch Service direct queries with Amazon S3.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", "code": 200 } } }, "com.amazonaws.opensearch#ListDataSourcesRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the ListDataSources operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListDataSourcesResponse": { "type": "structure", "members": { "DataSources": { "target": "com.amazonaws.opensearch#DataSourceList", "traits": { "smithy.api#documentation": "

A list of data sources associated with specified domain.

" } } }, "traits": { "smithy.api#documentation": "

The result of a ListDataSources operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListDirectQueryDataSources": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListDirectQueryDataSourcesRequest" }, "output": { "target": "com.amazonaws.opensearch#ListDirectQueryDataSourcesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists an inventory of all the direct query data sources that you have configured\n within Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/directQueryDataSource", "code": 200 } } }, "com.amazonaws.opensearch#ListDirectQueryDataSourcesRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#httpQuery": "nexttoken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListDirectQueryDataSourcesResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.opensearch#NextToken" }, "DirectQueryDataSources": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceList", "traits": { "smithy.api#documentation": "

A list of the direct query data sources that are returned by the\n ListDirectQueryDataSources API operation.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListDomainMaintenances": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListDomainMaintenancesRequest" }, "output": { "target": "com.amazonaws.opensearch#ListDomainMaintenancesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

A list of maintenance actions for the domain.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#ListDomainMaintenancesRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.opensearch#MaintenanceType", "traits": { "smithy.api#documentation": "

The name of the action.

", "smithy.api#httpQuery": "action" } }, "Status": { "target": "com.amazonaws.opensearch#MaintenanceStatus", "traits": { "smithy.api#documentation": "

The status of the action.

", "smithy.api#httpQuery": "status" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

If your initial ListDomainMaintenances operation returns a\n nextToken, include the returned nextToken in subsequent\n ListDomainMaintenances operations, which returns results in the next\n page.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the ListDomainMaintenances\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListDomainMaintenancesResponse": { "type": "structure", "members": { "DomainMaintenances": { "target": "com.amazonaws.opensearch#DomainMaintenanceList", "traits": { "smithy.api#documentation": "

A list of the submitted maintenance actions.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

The result of a ListDomainMaintenances request that contains information\n about the requested actions.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListDomainNames": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListDomainNamesRequest" }, "output": { "target": "com.amazonaws.opensearch#ListDomainNamesResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the names of all Amazon OpenSearch Service domains owned by the current user\n in the active Region.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/domain", "code": 200 } } }, "com.amazonaws.opensearch#ListDomainNamesRequest": { "type": "structure", "members": { "EngineType": { "target": "com.amazonaws.opensearch#EngineType", "traits": { "smithy.api#documentation": "

Filters the output by domain engine type.

", "smithy.api#httpQuery": "engineType" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the ListDomainNames operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListDomainNamesResponse": { "type": "structure", "members": { "DomainNames": { "target": "com.amazonaws.opensearch#DomainInfoList", "traits": { "smithy.api#documentation": "

The names of all OpenSearch Service domains owned by the current user and their\n respective engine types.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListDomainsForPackage": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListDomainsForPackageRequest" }, "output": { "target": "com.amazonaws.opensearch#ListDomainsForPackageResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all Amazon OpenSearch Service domains associated with a given package. For more\n information, see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/packages/{PackageID}/domains", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#ListDomainsForPackageRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

The unique identifier of the package for which to list associated domains.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the ListDomainsForPackage\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListDomainsForPackageResponse": { "type": "structure", "members": { "DomainPackageDetailsList": { "target": "com.amazonaws.opensearch#DomainPackageDetailsList", "traits": { "smithy.api#documentation": "

Information about all domains associated with a package.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response parameters to the ListDomainsForPackage\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListInsights": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListInsightsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListInsightsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account.\n Returns a paginated list of insights based on the specified entity, filters, time range,\n and sort order.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/insights", "code": 200 } } }, "com.amazonaws.opensearch#ListInsightsRequest": { "type": "structure", "members": { "Entity": { "target": "com.amazonaws.opensearch#InsightEntity", "traits": { "smithy.api#documentation": "

The entity for which to list insights. Specifies the type and value of the entity,\n such as a domain name or Amazon Web Services account ID.

", "smithy.api#required": {} } }, "TimeRange": { "target": "com.amazonaws.opensearch#InsightTimeRange", "traits": { "smithy.api#documentation": "

The time range for filtering insights, specified as epoch millisecond timestamps.

" } }, "SortOrder": { "target": "com.amazonaws.opensearch#InsightSortOrder", "traits": { "smithy.api#documentation": "

The sort order for the results. Possible values are ASC (ascending) and\n DESC (descending).

" } }, "MaxResults": { "target": "com.amazonaws.opensearch#InsightPageSize", "traits": { "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use NextToken to get the next page of results. Valid values are 1 to\n 500.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

If your initial ListInsights operation returns a\n NextToken, include the returned NextToken in subsequent\n ListInsights operations to retrieve the next page of results.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the ListInsights operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListInsightsResponse": { "type": "structure", "members": { "Insights": { "target": "com.amazonaws.opensearch#InsightList", "traits": { "smithy.api#documentation": "

The list of insights returned for the specified entity.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When NextToken is returned, there are more results available. The value\n of NextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

The result of a ListInsights request. Contains the list of insights and\n a pagination token for retrieving the next page of results.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListInstanceTypeDetails": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListInstanceTypeDetailsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListInstanceTypeDetailsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all instance types and available features for a given OpenSearch or\n Elasticsearch version.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#ListInstanceTypeDetailsRequest": { "type": "structure", "members": { "EngineVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or\n OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpQuery": "domainName" } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } }, "RetrieveAZs": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

An optional parameter that specifies the Availability Zones for the domain.

", "smithy.api#httpQuery": "retrieveAZs" } }, "InstanceType": { "target": "com.amazonaws.opensearch#InstanceTypeString", "traits": { "smithy.api#documentation": "

An optional parameter that lists information for a given instance type.

", "smithy.api#httpQuery": "instanceType" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListInstanceTypeDetailsResponse": { "type": "structure", "members": { "InstanceTypeDetails": { "target": "com.amazonaws.opensearch#InstanceTypeDetailsList", "traits": { "smithy.api#documentation": "

Lists all supported instance types and features for the given OpenSearch or\n Elasticsearch version.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListMigrations": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListMigrationsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListMigrationsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists migration jobs for an Amazon OpenSearch Service application. You can filter results by migration status. Use pagination to ensure that the operation returns quickly and successfully.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/app-migrations", "code": 200 } } }, "com.amazonaws.opensearch#ListMigrationsRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application to list migrations for.

", "smithy.api#httpQuery": "applicationId", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

Filters the results by migration status. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED.

", "smithy.api#httpQuery": "status" } }, "maxResults": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of results to return in a single call.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The pagination token from a previous call to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListMigrationsResponse": { "type": "structure", "members": { "migrations": { "target": "com.amazonaws.opensearch#MigrationSummaryList", "traits": { "smithy.api#documentation": "

A list of migration job summaries for the specified application.

" } }, "nextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The pagination token to use in a subsequent call to retrieve the next set of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListPackagesForDomain": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListPackagesForDomainRequest" }, "output": { "target": "com.amazonaws.opensearch#ListPackagesForDomainResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all packages associated with an Amazon OpenSearch Service domain. For more\n information, see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/domain/{DomainName}/packages", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#ListPackagesForDomainRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the ListPackagesForDomain\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListPackagesForDomainResponse": { "type": "structure", "members": { "DomainPackageDetailsList": { "target": "com.amazonaws.opensearch#DomainPackageDetailsList", "traits": { "smithy.api#documentation": "

List of all packages associated with a domain.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response parameters to the ListPackagesForDomain\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListScheduledActions": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListScheduledActionsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListScheduledActionsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#InvalidPaginationTokenException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves a list of configuration changes that are scheduled for a domain. These\n changes can be service\n software updates or blue/green Auto-Tune enhancements.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/scheduledActions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#ListScheduledActionsRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListScheduledActionsResponse": { "type": "structure", "members": { "ScheduledActions": { "target": "com.amazonaws.opensearch#ScheduledActionsList", "traits": { "smithy.api#documentation": "

A list of actions that are scheduled for the domain.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListTags": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListTagsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListTagsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns all resource tags for an Amazon OpenSearch Service domain, data source, or\n application. For more information, see Tagging Amazon OpenSearch Service resources.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/tags", "code": 200 } } }, "com.amazonaws.opensearch#ListTagsRequest": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) for the domain, data source, or application to view tags\n for.

", "smithy.api#httpQuery": "arn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the ListTags operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListTagsResponse": { "type": "structure", "members": { "TagList": { "target": "com.amazonaws.opensearch#TagList", "traits": { "smithy.api#documentation": "

List of resource tags associated with the specified domain, data source, or\n application.

" } } }, "traits": { "smithy.api#documentation": "

The results of a ListTags operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListVersions": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListVersionsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListVersionsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service\n supports.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.opensearch#ListVersionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the ListVersions\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListVersionsResponse": { "type": "structure", "members": { "Versions": { "target": "com.amazonaws.opensearch#VersionList", "traits": { "smithy.api#documentation": "

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service\n supports.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters for response received from the ListVersions\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListVpcEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListVpcEndpointAccessRequest" }, "output": { "target": "com.amazonaws.opensearch#ListVpcEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about each Amazon Web Services principal that is allowed to\n access a given Amazon OpenSearch Service domain through the use of an interface VPC\n endpoint.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess", "code": 200 } } }, "com.amazonaws.opensearch#ListVpcEndpointAccessRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the OpenSearch Service domain to retrieve access information for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListVpcEndpointAccessResponse": { "type": "structure", "members": { "AuthorizedPrincipalList": { "target": "com.amazonaws.opensearch#AuthorizedPrincipalList", "traits": { "smithy.api#documentation": "

A list of IAM\n principals that can currently access the domain.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListVpcEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListVpcEndpointsRequest" }, "output": { "target": "com.amazonaws.opensearch#ListVpcEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" } ], "traits": { "smithy.api#documentation": "

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/vpcEndpoints", "code": 200 } } }, "com.amazonaws.opensearch#ListVpcEndpointsForDomain": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#ListVpcEndpointsForDomainRequest" }, "output": { "target": "com.amazonaws.opensearch#ListVpcEndpointsForDomainResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a\n particular domain.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints", "code": 200 } } }, "com.amazonaws.opensearch#ListVpcEndpointsForDomainRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain to list associated VPC endpoints for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListVpcEndpointsForDomainResponse": { "type": "structure", "members": { "VpcEndpointSummaryList": { "target": "com.amazonaws.opensearch#VpcEndpointSummaryList", "traits": { "smithy.api#documentation": "

Information about each endpoint associated with the domain.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#ListVpcEndpointsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#ListVpcEndpointsResponse": { "type": "structure", "members": { "VpcEndpointSummaryList": { "target": "com.amazonaws.opensearch#VpcEndpointSummaryList", "traits": { "smithy.api#documentation": "

Information about each endpoint.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#LogPublishingOption": { "type": "structure", "members": { "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.opensearch#CloudWatchLogsLogGroupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

" } }, "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the log should be published.

" } } }, "traits": { "smithy.api#documentation": "

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch\n application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

\n \n

After you enable log publishing, you still have to enable the collection of slow\n logs using the OpenSearch REST API.

\n
" } }, "com.amazonaws.opensearch#LogPublishingOptions": { "type": "map", "key": { "target": "com.amazonaws.opensearch#LogType" }, "value": { "target": "com.amazonaws.opensearch#LogPublishingOption" } }, "com.amazonaws.opensearch#LogPublishingOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#LogPublishingOptions", "traits": { "smithy.api#documentation": "

The log publishing options configured for the domain.

" } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the log publishing options for the domain.

" } } }, "traits": { "smithy.api#documentation": "

The configured log publishing options for the domain and their current status.

" } }, "com.amazonaws.opensearch#LogType": { "type": "enum", "members": { "INDEX_SLOW_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INDEX_SLOW_LOGS" } }, "SEARCH_SLOW_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEARCH_SLOW_LOGS" } }, "ES_APPLICATION_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ES_APPLICATION_LOGS" } }, "AUDIT_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUDIT_LOGS" } } }, "traits": { "smithy.api#documentation": "

The type of log file. Can be one of the following:

\n " } }, "com.amazonaws.opensearch#Long": { "type": "long" }, "com.amazonaws.opensearch#MaintenanceStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "TIMED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMED_OUT" } } } }, "com.amazonaws.opensearch#MaintenanceStatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^([\\s\\S]*)$" } }, "com.amazonaws.opensearch#MaintenanceType": { "type": "enum", "members": { "REBOOT_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REBOOT_NODE" } }, "RESTART_SEARCH_PROCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTART_SEARCH_PROCESS" } }, "RESTART_DASHBOARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTART_DASHBOARD" } } } }, "com.amazonaws.opensearch#MasterNodeStatus": { "type": "enum", "members": { "Available": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Available" } }, "UnAvailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UnAvailable" } } } }, "com.amazonaws.opensearch#MasterUserOptions": { "type": "structure", "members": { "MasterUserARN": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) for the master user. Only specify if\n InternalUserDatabaseEnabled is false.

" } }, "MasterUserName": { "target": "com.amazonaws.opensearch#Username", "traits": { "smithy.api#documentation": "

User name for the master user. Only specify if\n InternalUserDatabaseEnabled is true.

" } }, "MasterUserPassword": { "target": "com.amazonaws.opensearch#Password", "traits": { "smithy.api#documentation": "

Password for the master user. Only specify if InternalUserDatabaseEnabled\n is true.

" } } }, "traits": { "smithy.api#documentation": "

Credentials for the master user for a domain.

" } }, "com.amazonaws.opensearch#MaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return for a\n given request.

", "smithy.api#range": { "max": 100 } } }, "com.amazonaws.opensearch#MaximumInstanceCount": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#MetadataCategory": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.opensearch#MetadataCategoryList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#MetadataCategory" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.opensearch#MigrationError": { "type": "structure", "members": { "code": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The error code identifying the type of failure.

" } }, "message": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A human-readable description of the error.

" } } }, "traits": { "smithy.api#documentation": "

Contains error details for a migration that failed or completed with errors.

" } }, "com.amazonaws.opensearch#MigrationOptions": { "type": "structure", "members": { "source": { "target": "com.amazonaws.opensearch#MigrationSource", "traits": { "smithy.api#documentation": "

The data source from which to export saved objects.

", "smithy.api#required": {} } }, "workspace": { "target": "com.amazonaws.opensearch#MigrationWorkspace", "traits": { "smithy.api#documentation": "

The target workspace configuration for importing saved objects. You can specify an existing workspace or request creation of a new workspace.

", "smithy.api#required": {} } }, "exportOptions": { "target": "com.amazonaws.opensearch#ExportOptions", "traits": { "smithy.api#documentation": "

Options to filter the scope of saved objects to export from the source.

" } }, "conflictResolution": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The strategy for resolving conflicts when saved objects already exist in the target workspace. Valid values are CREATE_NEW_COPIES, which creates new objects with unique IDs, and overwrite, which replaces existing objects.

" } } }, "traits": { "smithy.api#documentation": "

The configuration options for a saved objects migration job.

" } }, "com.amazonaws.opensearch#MigrationSource": { "type": "structure", "members": { "datasourceArn": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source to migrate saved objects from.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The source configuration for a migration, specifying the data source from which to export saved objects.

" } }, "com.amazonaws.opensearch#MigrationSummary": { "type": "structure", "members": { "migrationId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the migration job.

" } }, "status": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current status of the migration job.

" } }, "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application associated with the migration.

" } }, "source": { "target": "com.amazonaws.opensearch#MigrationSource", "traits": { "smithy.api#documentation": "

The source configuration for the migration.

" } }, "exportedCount": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of saved objects exported from the source data source.

" } }, "importedCount": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of saved objects successfully imported into the target workspace.

" } }, "error": { "target": "com.amazonaws.opensearch#MigrationError", "traits": { "smithy.api#documentation": "

Error details if the migration failed or completed with errors.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the migration job was created.

" } }, "updatedAt": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the migration job was last updated.

" } } }, "traits": { "smithy.api#documentation": "

A summary of a migration job, including its status and progress.

" } }, "com.amazonaws.opensearch#MigrationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#MigrationSummary" } }, "com.amazonaws.opensearch#MigrationWorkspace": { "type": "structure", "members": { "workspaceId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of an existing workspace to use as the migration target. Specify either this parameter or createWorkspace.

" } }, "createWorkspace": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to create a new workspace as the migration target. If true, you must also specify name.

" } }, "name": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The name of the new workspace to create. Required when createWorkspace is true.

" } }, "type": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The type of the new workspace to create.

" } } }, "traits": { "smithy.api#documentation": "

The target workspace configuration for a migration. You can specify an existing workspace by ID or request creation of a new workspace.

" } }, "com.amazonaws.opensearch#MinimumInstanceCount": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Minimum number of instances that can be instantiated for a given instance\n type.

" } }, "com.amazonaws.opensearch#ModifyingProperties": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The name of the property that is currently being modified.

" } }, "ActiveValue": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current value of the domain property that is being modified.

" } }, "PendingValue": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The value that the property that is currently being modified will eventually\n have.

" } }, "ValueType": { "target": "com.amazonaws.opensearch#PropertyValueType", "traits": { "smithy.api#documentation": "

The type of value that is currently being modified. Properties can have two\n types:

\n " } } }, "traits": { "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" } }, "com.amazonaws.opensearch#ModifyingPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ModifyingProperties" } }, "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState": { "type": "enum", "members": { "NotEnabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_ENABLED" } }, "EnableComplete": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLE_COMPLETE" } }, "EnableInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLE_IN_PROGRESS" } }, "EnableFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLE_FAILED" } }, "DisableComplete": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLE_COMPLETE" } }, "DisableInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLE_IN_PROGRESS" } }, "DisableFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLE_FAILED" } } } }, "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput": { "type": "structure", "members": { "DesiredState": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", "traits": { "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are\n ENABLED and DISABLED.

" } } }, "traits": { "smithy.api#documentation": "

Container for parameters required to enable the natural language query generation\n feature.

" } }, "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput": { "type": "structure", "members": { "DesiredState": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", "traits": { "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are\n ENABLED and DISABLED.

" } }, "CurrentState": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState", "traits": { "smithy.api#documentation": "

The current state of the natural language query generation feature, indicating\n completion, in progress, or failure.

" } } }, "traits": { "smithy.api#documentation": "

Container for parameters representing the state of the natural language query\n generation feature on the specified domain.

" } }, "com.amazonaws.opensearch#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Send the request\n again using the returned token to retrieve the next page.

" } }, "com.amazonaws.opensearch#NodeConfig": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

A boolean value indicating whether a specific node type is active or inactive.

" } }, "Type": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

The instance type of a particular node within the cluster.

" } }, "Count": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

The number of nodes of a specific type within the cluster.

" } } }, "traits": { "smithy.api#documentation": "

Configuration options for defining the setup of any node type within the\n cluster.

" } }, "com.amazonaws.opensearch#NodeId": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 40 } } }, "com.amazonaws.opensearch#NodeOption": { "type": "structure", "members": { "NodeType": { "target": "com.amazonaws.opensearch#NodeOptionsNodeType", "traits": { "smithy.api#documentation": "

Defines the type of node, such as coordinating nodes.

" } }, "NodeConfig": { "target": "com.amazonaws.opensearch#NodeConfig", "traits": { "smithy.api#documentation": "

Configuration options for defining the setup of any node type.

" } } }, "traits": { "smithy.api#documentation": "

Configuration settings for defining the node type within a cluster.

" } }, "com.amazonaws.opensearch#NodeOptionsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#NodeOption" } }, "com.amazonaws.opensearch#NodeOptionsNodeType": { "type": "enum", "members": { "COORDINATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "coordinator" } } } }, "com.amazonaws.opensearch#NodeStatus": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "StandBy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StandBy" } }, "NotAvailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotAvailable" } } } }, "com.amazonaws.opensearch#NodeToNodeEncryptionOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable node-to-node encryption.

" } } }, "traits": { "smithy.api#documentation": "

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#NodeToNodeEncryptionOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#NodeToNodeEncryptionOptions", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Status of the node-to-node encryption options for the specified domain.

" } }, "com.amazonaws.opensearch#NodeType": { "type": "enum", "members": { "Data": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Data" } }, "Ultrawarm": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ultrawarm" } }, "Master": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Master" } }, "Warm": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warm" } } } }, "com.amazonaws.opensearch#NonEmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]+$" } }, "com.amazonaws.opensearch#NumberOfAZs": { "type": "string", "traits": { "smithy.api#pattern": "^((\\d+)|(NotAvailable))$" } }, "com.amazonaws.opensearch#NumberOfNodes": { "type": "string", "traits": { "smithy.api#pattern": "^((\\d+)|(NotAvailable))$" } }, "com.amazonaws.opensearch#NumberOfShards": { "type": "string", "traits": { "smithy.api#pattern": "^((\\d+)|(NotAvailable))$" } }, "com.amazonaws.opensearch#OffPeakWindow": { "type": "structure", "members": { "WindowStartTime": { "target": "com.amazonaws.opensearch#WindowStartTime", "traits": { "smithy.api#documentation": "

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The\n window length will always be 10 hours, so you can't specify an end time. For example, if\n you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to\n 9:00 A.M.

" } } }, "traits": { "smithy.api#documentation": "

A custom 10-hour, low-traffic window during which OpenSearch Service can perform\n mandatory configuration changes on the domain. These actions can include scheduled\n service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will\n schedule these actions during the window that you specify.

\n

If you don't specify a window start time, it defaults to 10:00 P.M. local time.

\n

For more information, see Defining off-peak\n maintenance windows for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#OffPeakWindowOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable an off-peak window.

\n

This option is only available when modifying a domain created prior to February 16,\n 2023, not when creating a new domain. All domains created after this date have the\n off-peak window enabled by default. You can't disable the off-peak window after it's\n enabled for a domain.

" } }, "OffPeakWindow": { "target": "com.amazonaws.opensearch#OffPeakWindow", "traits": { "smithy.api#documentation": "

Off-peak window settings for the domain.

" } } }, "traits": { "smithy.api#documentation": "

Options for a domain's off-peak\n window, during which OpenSearch Service can perform mandatory configuration\n changes on the domain.

" } }, "com.amazonaws.opensearch#OffPeakWindowOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#OffPeakWindowOptions", "traits": { "smithy.api#documentation": "

The domain's off-peak window configuration.

" } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The current status of off-peak window options.

" } } }, "traits": { "smithy.api#documentation": "

The status of off-peak\n window options for a domain.

" } }, "com.amazonaws.opensearch#OpenSearchPartitionInstanceType": { "type": "enum", "members": { "m3_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m3.medium.search" } }, "m3_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m3.large.search" } }, "m3_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m3.xlarge.search" } }, "m3_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m3.2xlarge.search" } }, "m4_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m4.large.search" } }, "m4_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m4.xlarge.search" } }, "m4_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m4.2xlarge.search" } }, "m4_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m4.4xlarge.search" } }, "m4_10xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m4.10xlarge.search" } }, "m5_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m5.large.search" } }, "m5_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m5.xlarge.search" } }, "m5_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m5.2xlarge.search" } }, "m5_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m5.4xlarge.search" } }, "m5_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m5.12xlarge.search" } }, "m5_24xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m5.24xlarge.search" } }, "r5_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r5.large.search" } }, "r5_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r5.xlarge.search" } }, "r5_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r5.2xlarge.search" } }, "r5_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r5.4xlarge.search" } }, "r5_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r5.12xlarge.search" } }, "r5_24xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r5.24xlarge.search" } }, "c5_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c5.large.search" } }, "c5_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c5.xlarge.search" } }, "c5_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c5.2xlarge.search" } }, "c5_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c5.4xlarge.search" } }, "c5_9xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c5.9xlarge.search" } }, "c5_18xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c5.18xlarge.search" } }, "t3_nano_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.nano.search" } }, "t3_micro_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.micro.search" } }, "t3_small_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.small.search" } }, "t3_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.medium.search" } }, "t3_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.large.search" } }, "t3_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.xlarge.search" } }, "t3_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t3.2xlarge.search" } }, "or1_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.medium.search" } }, "or1_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.large.search" } }, "or1_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.xlarge.search" } }, "or1_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.2xlarge.search" } }, "or1_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.4xlarge.search" } }, "or1_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.8xlarge.search" } }, "or1_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.12xlarge.search" } }, "or1_16xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "or1.16xlarge.search" } }, "ultrawarm1_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ultrawarm1.medium.search" } }, "ultrawarm1_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ultrawarm1.large.search" } }, "ultrawarm1_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ultrawarm1.xlarge.search" } }, "t2_micro_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t2.micro.search" } }, "t2_small_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t2.small.search" } }, "t2_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t2.medium.search" } }, "r3_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r3.large.search" } }, "r3_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r3.xlarge.search" } }, "r3_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r3.2xlarge.search" } }, "r3_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r3.4xlarge.search" } }, "r3_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r3.8xlarge.search" } }, "i2_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i2.xlarge.search" } }, "i2_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i2.2xlarge.search" } }, "d2_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "d2.xlarge.search" } }, "d2_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "d2.2xlarge.search" } }, "d2_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "d2.4xlarge.search" } }, "d2_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "d2.8xlarge.search" } }, "c4_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c4.large.search" } }, "c4_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c4.xlarge.search" } }, "c4_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c4.2xlarge.search" } }, "c4_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c4.4xlarge.search" } }, "c4_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c4.8xlarge.search" } }, "r4_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r4.large.search" } }, "r4_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r4.xlarge.search" } }, "r4_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r4.2xlarge.search" } }, "r4_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r4.4xlarge.search" } }, "r4_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r4.8xlarge.search" } }, "r4_16xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r4.16xlarge.search" } }, "i3_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i3.large.search" } }, "i3_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i3.xlarge.search" } }, "i3_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i3.2xlarge.search" } }, "i3_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i3.4xlarge.search" } }, "i3_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i3.8xlarge.search" } }, "i3_16xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "i3.16xlarge.search" } }, "r6g_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6g.large.search" } }, "r6g_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6g.xlarge.search" } }, "r6g_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6g.2xlarge.search" } }, "r6g_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6g.4xlarge.search" } }, "r6g_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6g.8xlarge.search" } }, "r6g_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6g.12xlarge.search" } }, "m6g_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m6g.large.search" } }, "m6g_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m6g.xlarge.search" } }, "m6g_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m6g.2xlarge.search" } }, "m6g_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m6g.4xlarge.search" } }, "m6g_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m6g.8xlarge.search" } }, "m6g_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "m6g.12xlarge.search" } }, "c6g_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c6g.large.search" } }, "c6g_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c6g.xlarge.search" } }, "c6g_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c6g.2xlarge.search" } }, "c6g_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c6g.4xlarge.search" } }, "c6g_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c6g.8xlarge.search" } }, "c6g_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "c6g.12xlarge.search" } }, "r6gd_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.large.search" } }, "r6gd_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.xlarge.search" } }, "r6gd_2xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.2xlarge.search" } }, "r6gd_4xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.4xlarge.search" } }, "r6gd_8xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.8xlarge.search" } }, "r6gd_12xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.12xlarge.search" } }, "r6gd_16xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "r6gd.16xlarge.search" } }, "t4g_small_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t4g.small.search" } }, "t4g_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "t4g.medium.search" } } } }, "com.amazonaws.opensearch#OpenSearchWarmPartitionInstanceType": { "type": "enum", "members": { "ultrawarm1_medium_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ultrawarm1.medium.search" } }, "ultrawarm1_large_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ultrawarm1.large.search" } }, "ultrawarm1_xlarge_search": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ultrawarm1.xlarge.search" } } } }, "com.amazonaws.opensearch#OptionState": { "type": "enum", "members": { "RequiresIndexDocuments": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RequiresIndexDocuments" } }, "Processing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Processing" } }, "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } } }, "traits": { "smithy.api#documentation": "

The state of a requested domain configuration change. Can be one of the\n following:

\n " } }, "com.amazonaws.opensearch#OptionStatus": { "type": "structure", "members": { "CreationDate": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The timestamp when the entity was created.

", "smithy.api#required": {} } }, "UpdateDate": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The timestamp of the last time the entity was updated.

", "smithy.api#required": {} } }, "UpdateVersion": { "target": "com.amazonaws.opensearch#UIntValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The latest version of the entity.

" } }, "State": { "target": "com.amazonaws.opensearch#OptionState", "traits": { "smithy.api#documentation": "

The state of the entity.

", "smithy.api#required": {} } }, "PendingDeletion": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the entity is being deleted.

" } } }, "traits": { "smithy.api#documentation": "

Provides the current status of an entity.

" } }, "com.amazonaws.opensearch#OutboundConnection": { "type": "structure", "members": { "LocalDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Information about the source (local) domain.

" } }, "RemoteDomainInfo": { "target": "com.amazonaws.opensearch#DomainInformationContainer", "traits": { "smithy.api#documentation": "

Information about the destination (remote) domain.

" } }, "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

Unique identifier of the connection.

" } }, "ConnectionAlias": { "target": "com.amazonaws.opensearch#ConnectionAlias", "traits": { "smithy.api#documentation": "

Name of the connection.

" } }, "ConnectionStatus": { "target": "com.amazonaws.opensearch#OutboundConnectionStatus", "traits": { "smithy.api#documentation": "

Status of the connection.

" } }, "ConnectionMode": { "target": "com.amazonaws.opensearch#ConnectionMode", "traits": { "smithy.api#documentation": "

The connection mode.

" } }, "ConnectionProperties": { "target": "com.amazonaws.opensearch#ConnectionProperties", "traits": { "smithy.api#documentation": "

Properties for the outbound connection.

" } } }, "traits": { "smithy.api#documentation": "

Specifies details about an outbound cross-cluster connection.

" } }, "com.amazonaws.opensearch#OutboundConnectionStatus": { "type": "structure", "members": { "StatusCode": { "target": "com.amazonaws.opensearch#OutboundConnectionStatusCode", "traits": { "smithy.api#documentation": "

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

\n " } }, "Message": { "target": "com.amazonaws.opensearch#ConnectionStatusMessage", "traits": { "smithy.api#documentation": "

Verbose information for the outbound connection.

" } } }, "traits": { "smithy.api#documentation": "

The status of an outbound cross-cluster connection.

" } }, "com.amazonaws.opensearch#OutboundConnectionStatusCode": { "type": "enum", "members": { "VALIDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATING" } }, "VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_FAILED" } }, "PENDING_ACCEPTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ACCEPTANCE" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "REJECTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTING" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.opensearch#OutboundConnections": { "type": "list", "member": { "target": "com.amazonaws.opensearch#OutboundConnection" } }, "com.amazonaws.opensearch#OverallChangeStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "PROCESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROCESSING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "

The overall status value of the domain configuration change.

" } }, "com.amazonaws.opensearch#OwnerId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.opensearch#PackageAssociationConfiguration": { "type": "structure", "members": { "KeyStoreAccessOption": { "target": "com.amazonaws.opensearch#KeyStoreAccessOption", "traits": { "smithy.api#documentation": "

The configuration parameters to enable accessing the key store required by the\n package.

" } } }, "traits": { "smithy.api#documentation": "

The configuration for associating a package with a domain.

" } }, "com.amazonaws.opensearch#PackageConfiguration": { "type": "structure", "members": { "LicenseRequirement": { "target": "com.amazonaws.opensearch#RequirementLevel", "traits": { "smithy.api#documentation": "

The license requirements for the package.

", "smithy.api#required": {} } }, "LicenseFilepath": { "target": "com.amazonaws.opensearch#LicenseFilepath", "traits": { "smithy.api#documentation": "

The relative file path for the license associated with the package.

" } }, "ConfigurationRequirement": { "target": "com.amazonaws.opensearch#RequirementLevel", "traits": { "smithy.api#documentation": "

The configuration requirements for the package.

", "smithy.api#required": {} } }, "RequiresRestartForConfigurationUpdate": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

This indicates whether a B/G deployment is required for updating the configuration\n that the plugin is prerequisite for.

" } } }, "traits": { "smithy.api#documentation": "

The configuration parameters for a package.

" } }, "com.amazonaws.opensearch#PackageDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#PackageDetails": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

The unique identifier of the package.

" } }, "PackageName": { "target": "com.amazonaws.opensearch#PackageName", "traits": { "smithy.api#documentation": "

The user-specified name of the package.

" } }, "PackageType": { "target": "com.amazonaws.opensearch#PackageType", "traits": { "smithy.api#documentation": "

The type of package.

" } }, "PackageDescription": { "target": "com.amazonaws.opensearch#PackageDescription", "traits": { "smithy.api#documentation": "

User-specified description of the package.

" } }, "PackageStatus": { "target": "com.amazonaws.opensearch#PackageStatus", "traits": { "smithy.api#documentation": "

The current status of the package. The available options are AVAILABLE,\n COPYING, COPY_FAILED, VALIDATNG,\n VALIDATION_FAILED, DELETING, and\n DELETE_FAILED.

" } }, "CreatedAt": { "target": "com.amazonaws.opensearch#CreatedAt", "traits": { "smithy.api#documentation": "

The timestamp when the package was created.

" } }, "LastUpdatedAt": { "target": "com.amazonaws.opensearch#LastUpdated", "traits": { "smithy.api#documentation": "

Date and time when the package was last updated.

" } }, "AvailablePackageVersion": { "target": "com.amazonaws.opensearch#PackageVersion", "traits": { "smithy.api#documentation": "

The package version.

" } }, "ErrorDetails": { "target": "com.amazonaws.opensearch#ErrorDetails", "traits": { "smithy.api#documentation": "

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

" } }, "EngineVersion": { "target": "com.amazonaws.opensearch#EngineVersion", "traits": { "smithy.api#documentation": "

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or\n OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

" } }, "AvailablePluginProperties": { "target": "com.amazonaws.opensearch#PluginProperties", "traits": { "smithy.api#documentation": "

If the package is a ZIP-PLUGIN package, additional information about\n plugin properties.

" } }, "AvailablePackageConfiguration": { "target": "com.amazonaws.opensearch#PackageConfiguration", "traits": { "smithy.api#documentation": "

This represents the available configuration parameters for the package.

" } }, "AllowListedUserList": { "target": "com.amazonaws.opensearch#PackageUserList", "traits": { "smithy.api#documentation": "

A list of users who are allowed to view and associate the package. This field is only\n visible to the owner of a package.

" } }, "PackageOwner": { "target": "com.amazonaws.opensearch#PackageOwner", "traits": { "smithy.api#documentation": "

The owner of the package who is allowed to create and update a package and add users\n to the package scope.

" } }, "PackageVendingOptions": { "target": "com.amazonaws.opensearch#PackageVendingOptions", "traits": { "smithy.api#documentation": "

Package Vending Options for a package.

" } }, "PackageEncryptionOptions": { "target": "com.amazonaws.opensearch#PackageEncryptionOptions", "traits": { "smithy.api#documentation": "

Encryption options for a package.

" } } }, "traits": { "smithy.api#documentation": "

Basic information about a package.

" } }, "com.amazonaws.opensearch#PackageDetailsForAssociation": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

Internal ID of the package that you want to associate with a domain.

", "smithy.api#required": {} } }, "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { "smithy.api#documentation": "

List of package IDs that must be linked to the domain before or simultaneously with\n the package association.

" } }, "AssociationConfiguration": { "target": "com.amazonaws.opensearch#PackageAssociationConfiguration", "traits": { "smithy.api#documentation": "

The configuration parameters for associating the package with a domain.

" } } }, "traits": { "smithy.api#documentation": "

Details of a package that is associated with a domain.

" } }, "com.amazonaws.opensearch#PackageDetailsForAssociationList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#PackageDetailsForAssociation" } }, "com.amazonaws.opensearch#PackageDetailsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#PackageDetails" } }, "com.amazonaws.opensearch#PackageEncryptionOptions": { "type": "structure", "members": { "KmsKeyIdentifier": { "target": "com.amazonaws.opensearch#KmsKeyId", "traits": { "smithy.api#documentation": "

KMS key ID for encrypting the package.

" } }, "EncryptionEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether encryption is enabled for the package.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Encryption options for a package.

" } }, "com.amazonaws.opensearch#PackageID": { "type": "string", "traits": { "smithy.api#pattern": "^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$" } }, "com.amazonaws.opensearch#PackageIDList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#PackageID" } }, "com.amazonaws.opensearch#PackageName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 }, "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.opensearch#PackageOwner": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#PackageScopeOperationEnum": { "type": "enum", "members": { "ADD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADD" } }, "OVERRIDE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OVERRIDE" } }, "REMOVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REMOVE" } } } }, "com.amazonaws.opensearch#PackageSource": { "type": "structure", "members": { "S3BucketName": { "target": "com.amazonaws.opensearch#S3BucketName", "traits": { "smithy.api#documentation": "

The name of the Amazon S3 bucket containing the package.

" } }, "S3Key": { "target": "com.amazonaws.opensearch#S3Key", "traits": { "smithy.api#documentation": "

Key (file name) of the package.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 location to import the package from.

" } }, "com.amazonaws.opensearch#PackageStatus": { "type": "enum", "members": { "COPYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPYING" } }, "COPY_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPY_FAILED" } }, "VALIDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATING" } }, "VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_FAILED" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } } }, "com.amazonaws.opensearch#PackageType": { "type": "enum", "members": { "TXT_DICTIONARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TXT-DICTIONARY" } }, "ZIP_PLUGIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZIP-PLUGIN" } }, "PACKAGE_LICENSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PACKAGE-LICENSE" } }, "PACKAGE_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PACKAGE-CONFIG" } } } }, "com.amazonaws.opensearch#PackageUser": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$|^GLOBAL$" } }, "com.amazonaws.opensearch#PackageUserList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#PackageUser" } }, "com.amazonaws.opensearch#PackageVendingOptions": { "type": "structure", "members": { "VendingEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the package vending feature is enabled, allowing the package to be\n used by other users.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration options for determining whether a package can be made available for use\n by other users.

" } }, "com.amazonaws.opensearch#PackageVersion": { "type": "string" }, "com.amazonaws.opensearch#PackageVersionHistory": { "type": "structure", "members": { "PackageVersion": { "target": "com.amazonaws.opensearch#PackageVersion", "traits": { "smithy.api#documentation": "

The package version.

" } }, "CommitMessage": { "target": "com.amazonaws.opensearch#CommitMessage", "traits": { "smithy.api#documentation": "

A message associated with the package version when it was uploaded.

" } }, "CreatedAt": { "target": "com.amazonaws.opensearch#CreatedAt", "traits": { "smithy.api#documentation": "

The date and time when the package was created.

" } }, "PluginProperties": { "target": "com.amazonaws.opensearch#PluginProperties", "traits": { "smithy.api#documentation": "

Additional information about plugin properties if the package is a\n ZIP-PLUGIN package.

" } }, "PackageConfiguration": { "target": "com.amazonaws.opensearch#PackageConfiguration", "traits": { "smithy.api#documentation": "

The configuration details for a specific version of a package.

" } } }, "traits": { "smithy.api#documentation": "

Details about a package version.

" } }, "com.amazonaws.opensearch#PackageVersionHistoryList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#PackageVersionHistory" } }, "com.amazonaws.opensearch#Password": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 128 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.opensearch#PauseState": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Scheduled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } }, "traits": { "smithy.api#documentation": "

The state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled.

" } }, "com.amazonaws.opensearch#PluginClassName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#PluginDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#PluginName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#PluginProperties": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.opensearch#PluginName", "traits": { "smithy.api#documentation": "

The name of the plugin.

" } }, "Description": { "target": "com.amazonaws.opensearch#PluginDescription", "traits": { "smithy.api#documentation": "

The description of the plugin.

" } }, "Version": { "target": "com.amazonaws.opensearch#PluginVersion", "traits": { "smithy.api#documentation": "

The version of the plugin.

" } }, "ClassName": { "target": "com.amazonaws.opensearch#PluginClassName", "traits": { "smithy.api#documentation": "

The name of the class to load.

" } }, "UncompressedSizeInBytes": { "target": "com.amazonaws.opensearch#UncompressedPluginSizeInBytes", "traits": { "smithy.api#documentation": "

The uncompressed size of the plugin.

" } } }, "traits": { "smithy.api#documentation": "

Basic information about the plugin.

" } }, "com.amazonaws.opensearch#PluginVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.opensearch#PolicyDocument": { "type": "string", "traits": { "smithy.api#documentation": "

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more\n information, see Configuring access policies. The maximum size of a policy document is 100\n KB.

", "smithy.api#length": { "min": 0, "max": 102400 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#PrincipalType": { "type": "enum", "members": { "AWS_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_ACCOUNT" } }, "AWS_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_SERVICE" } } } }, "com.amazonaws.opensearch#PrometheusDirectQueryDataSource": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceRoleArn", "traits": { "smithy.api#documentation": "

The unique identifier of the IAM role that grants OpenSearch Service permission to access\n the specified data source.

", "smithy.api#required": {} } }, "WorkspaceArn": { "target": "com.amazonaws.opensearch#AMPWorkspaceArn", "traits": { "smithy.api#documentation": "

The unique identifier of the Amazon Managed Prometheus Workspace that is associated with the specified\n data source.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration details for a Prometheus data source that can be used for direct queries.\n

" } }, "com.amazonaws.opensearch#PropertyValueType": { "type": "enum", "members": { "PLAIN_TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLAIN_TEXT" } }, "STRINGIFIED_JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRINGIFIED_JSON" } } } }, "com.amazonaws.opensearch#PurchaseReservedInstanceOffering": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#PurchaseReservedInstanceOfferingRequest" }, "output": { "target": "com.amazonaws.opensearch#PurchaseReservedInstanceOfferingResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/purchaseReservedInstanceOffering", "code": 200 } } }, "com.amazonaws.opensearch#PurchaseReservedInstanceOfferingRequest": { "type": "structure", "members": { "ReservedInstanceOfferingId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The ID of the Reserved Instance offering to purchase.

", "smithy.api#required": {} } }, "ReservationName": { "target": "com.amazonaws.opensearch#ReservationToken", "traits": { "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

", "smithy.api#required": {} } }, "InstanceCount": { "target": "com.amazonaws.opensearch#InstanceCount", "traits": { "smithy.api#documentation": "

The number of OpenSearch instances to reserve.

" } } }, "traits": { "smithy.api#documentation": "

Container for request parameters to the PurchaseReservedInstanceOffering\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#PurchaseReservedInstanceOfferingResponse": { "type": "structure", "members": { "ReservedInstanceId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The ID of the Reserved Instance offering that was purchased.

" } }, "ReservationName": { "target": "com.amazonaws.opensearch#ReservationToken", "traits": { "smithy.api#documentation": "

The customer-specified identifier used to track this reservation.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output of a PurchaseReservedInstanceOffering\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#PutDefaultApplicationSetting": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#PutDefaultApplicationSettingRequest" }, "output": { "target": "com.amazonaws.opensearch#PutDefaultApplicationSettingResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Sets the default application to the application with the specified ARN.

\n

To remove the default application, use the GetDefaultApplicationSetting\n operation to get the current default and then call the\n PutDefaultApplicationSetting with the current applications ARN and the\n setAsDefault parameter set to false.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/defaultApplicationSetting", "code": 200 } } }, "com.amazonaws.opensearch#PutDefaultApplicationSettingRequest": { "type": "structure", "members": { "applicationArn": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#required": {} } }, "setAsDefault": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Set to true to set the specified ARN as the default application. Set to false to clear\n the default application.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#PutDefaultApplicationSettingResponse": { "type": "structure", "members": { "applicationArn": { "target": "com.amazonaws.opensearch#ARN" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#RecurringCharge": { "type": "structure", "members": { "RecurringChargeAmount": { "target": "com.amazonaws.opensearch#Double", "traits": { "smithy.api#documentation": "

The monetary amount of the recurring charge.

" } }, "RecurringChargeFrequency": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The frequency of the recurring charge.

" } } }, "traits": { "smithy.api#documentation": "

Contains the specific price and frequency of a recurring charges for an OpenSearch\n Reserved Instance, or for a Reserved Instance offering.

" } }, "com.amazonaws.opensearch#RecurringChargeList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#RecurringCharge", "traits": { "smithy.api#xmlName": "RecurringCharge" } } }, "com.amazonaws.opensearch#ReferencePath": { "type": "string" }, "com.amazonaws.opensearch#Region": { "type": "string", "traits": { "smithy.api#documentation": "

An Amazon Web Services Region, such as us-east-1.

", "smithy.api#length": { "min": 5, "max": 30 }, "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.opensearch#RegionsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#Region" } }, "com.amazonaws.opensearch#RegisterCapability": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#RegisterCapabilityRequest" }, "output": { "target": "com.amazonaws.opensearch#RegisterCapabilityResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Registers a capability for an OpenSearch UI application. Use this operation to enable specific capabilities, such as AI features, for a given application. The capability configuration defines the type and settings of the capability to register. For more information about the AI features, see Agentic AI for OpenSearch UI.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application/{applicationId}/capability/register", "code": 200 } } }, "com.amazonaws.opensearch#RegisterCapabilityRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch UI application to register the capability for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "capabilityName": { "target": "com.amazonaws.opensearch#CapabilityName", "traits": { "smithy.api#documentation": "

The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use ai-capability\n

", "smithy.api#required": {} } }, "capabilityConfig": { "target": "com.amazonaws.opensearch#CapabilityBaseRequestConfig", "traits": { "smithy.api#documentation": "

The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the RegisterCapability operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#RegisterCapabilityResponse": { "type": "structure", "members": { "capabilityName": { "target": "com.amazonaws.opensearch#CapabilityName", "traits": { "smithy.api#documentation": "

The name of the registered capability.

" } }, "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch UI application.

" } }, "status": { "target": "com.amazonaws.opensearch#CapabilityStatus", "traits": { "smithy.api#documentation": "

The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

" } }, "capabilityConfig": { "target": "com.amazonaws.opensearch#CapabilityBaseResponseConfig", "traits": { "smithy.api#documentation": "

The configuration settings for the registered capability.

" } } }, "traits": { "smithy.api#documentation": "

The result of a RegisterCapability request. Contains details about the registered capability.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#RejectInboundConnection": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#RejectInboundConnectionRequest" }, "output": { "target": "com.amazonaws.opensearch#RejectInboundConnectionResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound\n cross-cluster connection request.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject", "code": 200 } } }, "com.amazonaws.opensearch#RejectInboundConnectionRequest": { "type": "structure", "members": { "ConnectionId": { "target": "com.amazonaws.opensearch#ConnectionId", "traits": { "smithy.api#documentation": "

The unique identifier of the inbound connection to reject.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the RejectInboundConnection\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#RejectInboundConnectionResponse": { "type": "structure", "members": { "Connection": { "target": "com.amazonaws.opensearch#InboundConnection", "traits": { "smithy.api#documentation": "

Contains details about the rejected inbound connection.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output of a RejectInboundConnection operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#RemoveReplicationPeer": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#RemoveReplicationPeerRequest" }, "output": { "target": "com.amazonaws.opensearch#RemoveReplicationPeerResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Stops replicating a domain to its peer. Replication ends for both domains, and each domain\n keeps the data it holds at that point. Neither domain is deleted.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/replication/removePeer", "code": 200 } } }, "com.amazonaws.opensearch#RemoveReplicationPeerRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PeerDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the peer to stop replicating with. Both domains are named\n so that the request identifies exactly one replication relationship.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#RemoveReplicationPeerResponse": { "type": "structure", "members": { "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain that is no longer replicating.

" } }, "Status": { "target": "com.amazonaws.opensearch#ReplicationStatus", "traits": { "smithy.api#documentation": "

The state of the replication relationship. This is PENDING_REMOVAL while\n replication is being stopped.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#RemoveTags": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#RemoveTagsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes the specified set of tags from an Amazon OpenSearch Service domain, data\n source, or application. For more information, see Tagging Amazon OpenSearch Service resources.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/tags-removal", "code": 200 } } }, "com.amazonaws.opensearch#RemoveTagsRequest": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.opensearch#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain, data source, or application from which\n you want to delete the specified tags.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

The list of tag keys to remove from the domain, data source, or application.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the RemoveTags operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#ReplicationPeer": { "type": "structure", "members": { "PeerDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the peer domain.

" } }, "PeerRole": { "target": "com.amazonaws.opensearch#ReplicationRole", "traits": { "smithy.api#documentation": "

The peer's role in the relationship, either PRIMARY or\n SECONDARY.

" } }, "Status": { "target": "com.amazonaws.opensearch#ReplicationStatus", "traits": { "smithy.api#documentation": "

The state of the relationship:

\n \n

A relationship that is removed successfully no longer appears in Peers.

" } }, "StatusMessage": { "target": "com.amazonaws.opensearch#ReplicationStatusMessage", "traits": { "smithy.api#documentation": "

An explanation of why the relationship is in its current state, when more detail is\n available.

" } } }, "traits": { "smithy.api#documentation": "

A domain that another domain replicates with, and the state of that relationship.

" } }, "com.amazonaws.opensearch#ReplicationPeerList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ReplicationPeer" } }, "com.amazonaws.opensearch#ReplicationRole": { "type": "enum", "members": { "PRIMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIMARY" } }, "SECONDARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECONDARY" } } } }, "com.amazonaws.opensearch#ReplicationStatus": { "type": "enum", "members": { "PENDING_SETUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_SETUP" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "SWITCHING_OVER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SWITCHING_OVER" } }, "FAILING_OVER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILING_OVER" } }, "PENDING_REMOVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_REMOVAL" } }, "DETACHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DETACHED" } }, "EJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EJECTED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.opensearch#ReplicationStatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.opensearch#RequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^([\\s\\S]*)$" } }, "com.amazonaws.opensearch#RequirementLevel": { "type": "enum", "members": { "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRED" } }, "OPTIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPTIONAL" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.opensearch#ReservationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 64 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#ReservedInstance": { "type": "structure", "members": { "ReservationName": { "target": "com.amazonaws.opensearch#ReservationToken", "traits": { "smithy.api#documentation": "

The customer-specified identifier to track this reservation.

" } }, "ReservedInstanceId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier for the reservation.

" } }, "BillingSubscriptionId": { "target": "com.amazonaws.opensearch#Long", "traits": { "smithy.api#documentation": "

The unique identifier of the billing subscription.

" } }, "ReservedInstanceOfferingId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the Reserved Instance offering.

" } }, "InstanceType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

The OpenSearch instance type offered by theReserved Instance offering.

" } }, "StartTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { "smithy.api#documentation": "

The date and time when the reservation was purchased.

" } }, "Duration": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

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

" } }, "FixedPrice": { "target": "com.amazonaws.opensearch#Double", "traits": { "smithy.api#documentation": "

The upfront fixed charge you will paid to purchase the specific Reserved Instance\n offering.

" } }, "UsagePrice": { "target": "com.amazonaws.opensearch#Double", "traits": { "smithy.api#documentation": "

The hourly rate at which you're charged for the domain using this Reserved\n Instance.

" } }, "CurrencyCode": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The currency code for the offering.

" } }, "InstanceCount": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of OpenSearch instances that have been reserved.

" } }, "State": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The state of the Reserved Instance.

" } }, "PaymentOption": { "target": "com.amazonaws.opensearch#ReservedInstancePaymentOption", "traits": { "smithy.api#documentation": "

The payment option as defined in the Reserved Instance offering.

" } }, "RecurringCharges": { "target": "com.amazonaws.opensearch#RecurringChargeList", "traits": { "smithy.api#documentation": "

The recurring charge to your account, regardless of whether you create any domains\n using the Reserved Instance offering.

" } } }, "traits": { "smithy.api#documentation": "

Details of an OpenSearch Reserved Instance.

" } }, "com.amazonaws.opensearch#ReservedInstanceList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ReservedInstance" } }, "com.amazonaws.opensearch#ReservedInstanceOffering": { "type": "structure", "members": { "ReservedInstanceOfferingId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier of the Reserved Instance offering.

" } }, "InstanceType": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { "smithy.api#documentation": "

The OpenSearch instance type offered by the Reserved Instance offering.

" } }, "Duration": { "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

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

" } }, "FixedPrice": { "target": "com.amazonaws.opensearch#Double", "traits": { "smithy.api#documentation": "

The upfront fixed charge you will pay to purchase the specific Reserved Instance\n offering.

" } }, "UsagePrice": { "target": "com.amazonaws.opensearch#Double", "traits": { "smithy.api#documentation": "

The hourly rate at which you're charged for the domain using this Reserved\n Instance.

" } }, "CurrencyCode": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The currency code for the Reserved Instance offering.

" } }, "PaymentOption": { "target": "com.amazonaws.opensearch#ReservedInstancePaymentOption", "traits": { "smithy.api#documentation": "

Payment option for the Reserved Instance offering

" } }, "RecurringCharges": { "target": "com.amazonaws.opensearch#RecurringChargeList", "traits": { "smithy.api#documentation": "

The recurring charge to your account, regardless of whether you creates any domains\n using the offering.

" } } }, "traits": { "smithy.api#documentation": "

Details of an OpenSearch Reserved Instance offering.

" } }, "com.amazonaws.opensearch#ReservedInstanceOfferingList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ReservedInstanceOffering", "traits": { "smithy.api#xmlName": "ReservedInstanceOffering" } } }, "com.amazonaws.opensearch#ReservedInstancePaymentOption": { "type": "enum", "members": { "ALL_UPFRONT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL_UPFRONT" } }, "PARTIAL_UPFRONT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL_UPFRONT" } }, "NO_UPFRONT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_UPFRONT" } } } }, "com.amazonaws.opensearch#ResourceAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for creating a resource that already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for accessing or deleting a resource that doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#RetentionAction": { "type": "enum", "members": { "ROLLBACK_TO_PRIMARY_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RollbackToPrimaryCluster" } }, "DELETE_PRIMARY_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeletePrimaryCluster" } } }, "traits": { "smithy.api#documentation": "

The action that ends the retention period. RollbackToPrimaryCluster moves the domain back to the primary cluster. DeletePrimaryCluster deletes the primary cluster.

" } }, "com.amazonaws.opensearch#RetentionOptions": { "type": "union", "members": { "RetentionInHours": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

" } }, "RetentionAction": { "target": "com.amazonaws.opensearch#RetentionAction", "traits": { "smithy.api#documentation": "

Ends the retention period now. Valid only after cutover completes.

" } } }, "traits": { "smithy.api#documentation": "

Controls how long the cluster that you cut over from is kept after cutover completes. Specify exactly one of RetentionInHours or RetentionAction.

" } }, "com.amazonaws.opensearch#RevokeVpcEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#RevokeVpcEndpointAccessRequest" }, "output": { "target": "com.amazonaws.opensearch#RevokeVpcEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Revokes access to an Amazon OpenSearch Service domain that was provided through an\n interface VPC endpoint.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess", "code": 200 } } }, "com.amazonaws.opensearch#RevokeVpcEndpointAccessRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the OpenSearch Service domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.opensearch#AWSAccount", "traits": { "smithy.api#documentation": "

The account ID to revoke access from.

" } }, "Service": { "target": "com.amazonaws.opensearch#AWSServicePrincipal", "traits": { "smithy.api#documentation": "

The service SP to revoke access from.

" } }, "ServiceOptions": { "target": "com.amazonaws.opensearch#ServiceOptions", "traits": { "smithy.api#documentation": "

The options for the service, including the supported Regions for the endpoint\n access.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#RevokeVpcEndpointAccessResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/" } }, "com.amazonaws.opensearch#RolesKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.opensearch#RolesKeyIdCOption": { "type": "enum", "members": { "GroupName": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GroupName" } }, "GroupId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GroupId" } } } }, "com.amazonaws.opensearch#RollbackOnDisable": { "type": "enum", "members": { "NO_ROLLBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_ROLLBACK" } }, "DEFAULT_ROLLBACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT_ROLLBACK" } } }, "traits": { "smithy.api#documentation": "

The rollback state while disabling Auto-Tune for the domain.

" } }, "com.amazonaws.opensearch#RollbackServiceSoftwareOptions": { "type": "structure", "members": { "CurrentVersion": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current service software version on the domain.

" } }, "NewVersion": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The service software version that the domain will roll back to.

" } }, "RollbackAvailable": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether a service software rollback is available for the domain.

" } }, "Description": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A description of the rollback status.

" } } }, "traits": { "smithy.api#documentation": "

Details about the rollback options for a service software update.

" } }, "com.amazonaws.opensearch#RollbackServiceSoftwareUpdate": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#RollbackServiceSoftwareUpdateRequest" }, "output": { "target": "com.amazonaws.opensearch#RollbackServiceSoftwareUpdateResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Rolls back a service software update for a domain to the previous version. For more\n information, see Service\n software updates in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/serviceSoftwareUpdate/rollback", "code": 200 } } }, "com.amazonaws.opensearch#RollbackServiceSoftwareUpdateRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain to roll back the service software update on.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the\n RollbackServiceSoftwareUpdate operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#RollbackServiceSoftwareUpdateResponse": { "type": "structure", "members": { "RollbackServiceSoftwareOptions": { "target": "com.amazonaws.opensearch#RollbackServiceSoftwareOptions", "traits": { "smithy.api#documentation": "

The rollback options for the service software update.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about the rolled-back service software update.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#S3BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 } } }, "com.amazonaws.opensearch#S3GlueDataCatalog": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { "smithy.api#documentation": "

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

" } } }, "traits": { "smithy.api#documentation": "

Information about the Amazon S3 Glue Data Catalog.

" } }, "com.amazonaws.opensearch#S3Key": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.opensearch#S3VectorsEngine": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Enables S3 vectors engine features.

" } } }, "traits": { "smithy.api#documentation": "

Options for enabling S3 vectors engine features on the specified domain.

" } }, "com.amazonaws.opensearch#SAMLEntityId": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 512 } } }, "com.amazonaws.opensearch#SAMLIdp": { "type": "structure", "members": { "MetadataContent": { "target": "com.amazonaws.opensearch#SAMLMetadata", "traits": { "smithy.api#documentation": "

The metadata of the SAML application, in XML format.

", "smithy.api#required": {} } }, "EntityId": { "target": "com.amazonaws.opensearch#SAMLEntityId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The SAML identity povider information.

" } }, "com.amazonaws.opensearch#SAMLMetadata": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1048576 } } }, "com.amazonaws.opensearch#SAMLOptionsInput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True to enable SAML authentication for a domain.

" } }, "Idp": { "target": "com.amazonaws.opensearch#SAMLIdp", "traits": { "smithy.api#documentation": "

The SAML Identity Provider's information.

" } }, "MasterUserName": { "target": "com.amazonaws.opensearch#Username", "traits": { "smithy.api#documentation": "

The SAML master user name, which is stored in the domain's internal user\n database.

" } }, "MasterBackendRole": { "target": "com.amazonaws.opensearch#BackendRole", "traits": { "smithy.api#documentation": "

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

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

Element of the SAML assertion to use for the user name. Default is\n NameID.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

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

" } }, "SessionTimeoutMinutes": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

The SAML authentication configuration for an Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#SAMLOptionsOutput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True if SAML is enabled.

" } }, "Idp": { "target": "com.amazonaws.opensearch#SAMLIdp", "traits": { "smithy.api#documentation": "

Describes the SAML identity provider's information.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The key used for matching the SAML subject attribute.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The key used for matching the SAML roles attribute.

" } }, "SessionTimeoutMinutes": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Describes the SAML application configured for the domain.

" } }, "com.amazonaws.opensearch#SavedObjectIdentifier": { "type": "structure", "members": { "type": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The type of the saved object, such as dashboard, visualization, index-pattern, search, or query.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the saved object.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies a specific saved object by its type and unique identifier.

" } }, "com.amazonaws.opensearch#SavedObjectIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#SavedObjectIdentifier" } }, "com.amazonaws.opensearch#ScheduleAt": { "type": "enum", "members": { "NOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOW" } }, "TIMESTAMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMESTAMP" } }, "OFF_PEAK_WINDOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF_PEAK_WINDOW" } } } }, "com.amazonaws.opensearch#ScheduledAction": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the scheduled action.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.opensearch#ActionType", "traits": { "smithy.api#documentation": "

The type of action that will be taken on the domain.

", "smithy.api#required": {} } }, "Severity": { "target": "com.amazonaws.opensearch#ActionSeverity", "traits": { "smithy.api#documentation": "

The severity of the action.

", "smithy.api#required": {} } }, "ScheduledTime": { "target": "com.amazonaws.opensearch#Long", "traits": { "smithy.api#documentation": "

The time when the change is scheduled to happen.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A description of the action to be taken.

" } }, "ScheduledBy": { "target": "com.amazonaws.opensearch#ScheduledBy", "traits": { "smithy.api#documentation": "

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch\n Service automatically (SYSTEM).

" } }, "Status": { "target": "com.amazonaws.opensearch#ActionStatus", "traits": { "smithy.api#documentation": "

The current status of the scheduled action.

" } }, "Mandatory": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the action is required or optional.

" } }, "Cancellable": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether or not the scheduled action is cancellable.

" } } }, "traits": { "smithy.api#documentation": "

Information about a scheduled configuration change for an OpenSearch Service domain.\n This actions can be a service\n software update or a blue/green Auto-Tune enhancement.

" } }, "com.amazonaws.opensearch#ScheduledActionsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ScheduledAction" } }, "com.amazonaws.opensearch#ScheduledAutoTuneActionType": { "type": "enum", "members": { "JVM_HEAP_SIZE_TUNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JVM_HEAP_SIZE_TUNING" } }, "JVM_YOUNG_GEN_TUNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JVM_YOUNG_GEN_TUNING" } } }, "traits": { "smithy.api#documentation": "

The Auto-Tune action type.

" } }, "com.amazonaws.opensearch#ScheduledAutoTuneDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of an Auto-Tune maintenance action that occurs on a domain.

" } }, "com.amazonaws.opensearch#ScheduledAutoTuneDetails": { "type": "structure", "members": { "Date": { "target": "com.amazonaws.opensearch#AutoTuneDate", "traits": { "smithy.api#documentation": "

The date and time when the Auto-Tune action is scheduled for the domain.

" } }, "ActionType": { "target": "com.amazonaws.opensearch#ScheduledAutoTuneActionType", "traits": { "smithy.api#documentation": "

The type of Auto-Tune action.

" } }, "Action": { "target": "com.amazonaws.opensearch#ScheduledAutoTuneDescription", "traits": { "smithy.api#documentation": "

A description of the Auto-Tune action.

" } }, "Severity": { "target": "com.amazonaws.opensearch#ScheduledAutoTuneSeverityType", "traits": { "smithy.api#documentation": "

The severity of the Auto-Tune action. Valid values are LOW,\n MEDIUM, and HIGH.

" } } }, "traits": { "smithy.api#documentation": "

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#ScheduledAutoTuneSeverityType": { "type": "enum", "members": { "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } } }, "traits": { "smithy.api#documentation": "

The Auto-Tune action severity.

" } }, "com.amazonaws.opensearch#ScheduledBy": { "type": "enum", "members": { "CUSTOMER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER" } }, "SYSTEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SYSTEM" } } } }, "com.amazonaws.opensearch#SecurityLakeDirectQueryDataSource": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceRoleArn", "traits": { "smithy.api#documentation": "

The unique identifier of the IAM role that grants OpenSearch Service permission to\n access the specified data source.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration details for a Security Lake data source that can be used for direct\n queries.

" } }, "com.amazonaws.opensearch#ServerlessVectorAcceleration": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether serverless vector acceleration is enabled for the domain.

" } } }, "traits": { "smithy.api#documentation": "

Configuration for serverless vector acceleration, which provides GPU-accelerated vector\n search capabilities for improved performance on vector workloads.

" } }, "com.amazonaws.opensearch#ServiceOptions": { "type": "structure", "members": { "SupportedRegions": { "target": "com.amazonaws.opensearch#RegionsList", "traits": { "smithy.api#documentation": "

The list of supported Regions for the service.

" } } }, "traits": { "smithy.api#documentation": "

Options for the service, such as the supported Regions.

" } }, "com.amazonaws.opensearch#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for when a request would cause a service quota to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.opensearch#ServiceSoftwareOptions": { "type": "structure", "members": { "CurrentVersion": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The current service software version present on the domain.

" } }, "NewVersion": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The new service software version, if one is available.

" } }, "UpdateAvailable": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

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

" } }, "Cancellable": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

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

" } }, "UpdateStatus": { "target": "com.amazonaws.opensearch#DeploymentStatus", "traits": { "smithy.api#documentation": "

The status of your service software update.

" } }, "Description": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A description of the service software update status.

" } }, "AutomatedUpdateDate": { "target": "com.amazonaws.opensearch#DeploymentCloseDateTimeStamp", "traits": { "smithy.api#documentation": "

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

" } }, "OptionalDeployment": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

True if a service software is never automatically updated. False if a service software\n is automatically updated after the automated update date.

" } } }, "traits": { "smithy.api#documentation": "

The current status of the service software for an Amazon OpenSearch Service domain.\n For more information, see Service\n software updates in Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#ServiceUrl": { "type": "string", "traits": { "smithy.api#documentation": "

The domain endpoint to which index and search requests are submitted. For example,\n search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or\n doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

" } }, "com.amazonaws.opensearch#SkipUnavailableStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } }, "traits": { "smithy.api#documentation": "

The status of SkipUnavailable setting for the outbound connection.

\n " } }, "com.amazonaws.opensearch#SlotList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#Long" } }, "com.amazonaws.opensearch#SlotNotAvailableException": { "type": "structure", "members": { "SlotSuggestions": { "target": "com.amazonaws.opensearch#SlotList", "traits": { "smithy.api#documentation": "

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

" } }, "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for attempting to schedule a domain action during an unavailable time slot.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearch#SnapshotOptions": { "type": "structure", "members": { "AutomatedSnapshotStartHour": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#SnapshotOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#SnapshotOptions", "traits": { "smithy.api#documentation": "

The daily snapshot options specified for the domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of a daily automated snapshot.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Container for information about a daily automated snapshot for an OpenSearch Service\n domain.

" } }, "com.amazonaws.opensearch#SoftwareUpdateOptions": { "type": "structure", "members": { "AutoSoftwareUpdateEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether automatic service software updates are enabled for the domain.

" } }, "UseLatestServiceSoftwareForBlueGreen": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the domain should use the latest service software version during a\n blue/green deployment. If enabled, the domain will automatically use the latest\n available service software when a blue/green deployment is triggered.

" } } }, "traits": { "smithy.api#documentation": "

Options for configuring service software updates for a domain.

" } }, "com.amazonaws.opensearch#SoftwareUpdateOptionsStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#SoftwareUpdateOptions", "traits": { "smithy.api#documentation": "

The service software update options for a domain.

" } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of service software update options, including creation date and last\n updated date.

" } } }, "traits": { "smithy.api#documentation": "

The status of the service software options for a domain.

" } }, "com.amazonaws.opensearch#StartAt": { "type": "timestamp" }, "com.amazonaws.opensearch#StartDomainMaintenance": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#StartDomainMaintenanceRequest" }, "output": { "target": "com.amazonaws.opensearch#StartDomainMaintenanceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Starts the node maintenance process on the data node. These processes can include a\n node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana\n restart.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance", "code": 200 } } }, "com.amazonaws.opensearch#StartDomainMaintenanceRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.opensearch#MaintenanceType", "traits": { "smithy.api#documentation": "

The name of the action.

", "smithy.api#required": {} } }, "NodeId": { "target": "com.amazonaws.opensearch#NodeId", "traits": { "smithy.api#documentation": "

The ID of the data node.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the StartDomainMaintenance\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#StartDomainMaintenanceResponse": { "type": "structure", "members": { "MaintenanceId": { "target": "com.amazonaws.opensearch#RequestId", "traits": { "smithy.api#documentation": "

The request ID of requested action.

" } } }, "traits": { "smithy.api#documentation": "

The result of a StartDomainMaintenance request that information about the\n requested action.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#StartMigration": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#StartMigrationRequest" }, "output": { "target": "com.amazonaws.opensearch#StartMigrationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards, visualizations, index patterns, and searches. You can specify export filters to control the scope of the migration and a conflict resolution strategy for handling existing objects in the target workspace.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/app-migrations", "code": 200 } } }, "com.amazonaws.opensearch#StartMigrationRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.opensearch#ApplicationId", "traits": { "smithy.api#documentation": "

The unique identifier of the OpenSearch application to migrate saved objects into.

", "smithy.api#required": {} } }, "migrationOptions": { "target": "com.amazonaws.opensearch#MigrationOptions", "traits": { "smithy.api#documentation": "

The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.opensearch#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon OpenSearch Service ignores the request but does not return an error.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#StartMigrationResponse": { "type": "structure", "members": { "migrationId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the migration job.

" } }, "status": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The initial status of the migration job. The status is PENDING when a migration is first created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#StartServiceSoftwareUpdate": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#StartServiceSoftwareUpdateRequest" }, "output": { "target": "com.amazonaws.opensearch#StartServiceSoftwareUpdateResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Schedules a service software update for an Amazon OpenSearch Service domain. For more\n information, see Service\n software updates in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/serviceSoftwareUpdate/start", "code": 200 } } }, "com.amazonaws.opensearch#StartServiceSoftwareUpdateRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "ScheduleAt": { "target": "com.amazonaws.opensearch#ScheduleAt", "traits": { "smithy.api#documentation": "

When to start the service software update.

\n \n

Default: NOW if you don't specify a value for\n DesiredStartTime, and TIMESTAMP if you do.

" } }, "DesiredStartTime": { "target": "com.amazonaws.opensearch#Long", "traits": { "smithy.api#documentation": "

The Epoch timestamp when you want the service software update to start. You only need\n to specify this parameter if you set ScheduleAt to\n TIMESTAMP.

" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the StartServiceSoftwareUpdate\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#StartServiceSoftwareUpdateResponse": { "type": "structure", "members": { "ServiceSoftwareOptions": { "target": "com.amazonaws.opensearch#ServiceSoftwareOptions", "traits": { "smithy.api#documentation": "

The current status of the OpenSearch Service software update.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output of a StartServiceSoftwareUpdate operation. Contains\n the status of the update.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#StartTimeHours": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 23 } } }, "com.amazonaws.opensearch#StartTimeMinutes": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 59 } } }, "com.amazonaws.opensearch#StartTimestamp": { "type": "timestamp" }, "com.amazonaws.opensearch#StorageSubTypeName": { "type": "string", "traits": { "smithy.api#documentation": "

Sub-type of the given EBS storage type. List of available sub-storage options. The\n instance storage type has no storage sub-type. The ebs\n storage type has the following valid sub-types:

\n " } }, "com.amazonaws.opensearch#StorageType": { "type": "structure", "members": { "StorageTypeName": { "target": "com.amazonaws.opensearch#StorageTypeName", "traits": { "smithy.api#documentation": "

The name of the storage type.

" } }, "StorageSubTypeName": { "target": "com.amazonaws.opensearch#StorageSubTypeName", "traits": { "smithy.api#documentation": "

The storage sub-type, such as gp3 or io1.

" } }, "StorageTypeLimits": { "target": "com.amazonaws.opensearch#StorageTypeLimitList", "traits": { "smithy.api#documentation": "

Limits that are applicable for the given storage type.

" } } }, "traits": { "smithy.api#documentation": "

A list of storage types for an Amazon OpenSearch Service domain that are available for\n a given intance type.

" } }, "com.amazonaws.opensearch#StorageTypeLimit": { "type": "structure", "members": { "LimitName": { "target": "com.amazonaws.opensearch#LimitName", "traits": { "smithy.api#documentation": "

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

\n " } }, "LimitValues": { "target": "com.amazonaws.opensearch#LimitValueList", "traits": { "smithy.api#documentation": "

The limit values.

" } } }, "traits": { "smithy.api#documentation": "

Limits that are applicable for the given Amazon OpenSearch Service storage\n type.

" } }, "com.amazonaws.opensearch#StorageTypeLimitList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#StorageTypeLimit" } }, "com.amazonaws.opensearch#StorageTypeList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#StorageType" } }, "com.amazonaws.opensearch#StorageTypeName": { "type": "string", "traits": { "smithy.api#documentation": "

The type of storage that the domain uses. Can be one of the following:

\n
\n
instance
\n
\n

Built-in storage available for the instance.

\n
\n
ebs
\n
\n

Elastic Block Storage (EBS) attached to the instance.

\n
\n
" } }, "com.amazonaws.opensearch#String": { "type": "string" }, "com.amazonaws.opensearch#StringList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#String" } }, "com.amazonaws.opensearch#SubjectKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.opensearch#SubjectKeyIdCOption": { "type": "enum", "members": { "UserName": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UserName" } }, "UserId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UserId" } }, "Email": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Email" } } } }, "com.amazonaws.opensearch#SwitchoverReplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#SwitchoverReplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#SwitchoverReplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Promotes a secondary domain to primary, coordinating with the current primary so that no\n writes are lost. Use this operation for planned role changes, such as testing your recovery\n procedure or moving write traffic to another Region.

\n

Call this operation in the Region of the domain you want to promote. If the current primary\n is unreachable, use the FailoverReplication operation\n instead.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/replication/switchover", "code": 200 } } }, "com.amazonaws.opensearch#SwitchoverReplicationRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PeerDomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the relationship's current primary. The request is\n rejected if this domain is no longer the peer of the domain you are calling.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#SwitchoverReplicationResponse": { "type": "structure", "members": { "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain being promoted.

" } }, "Status": { "target": "com.amazonaws.opensearch#ReplicationStatus", "traits": { "smithy.api#documentation": "

The state of the replication relationship. This is SWITCHING_OVER while the\n promotion is in progress.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#TLSSecurityPolicy": { "type": "enum", "members": { "POLICY_MIN_TLS_1_0_2019_07": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy-Min-TLS-1-0-2019-07" } }, "POLICY_MIN_TLS_1_2_2019_07": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy-Min-TLS-1-2-2019-07" } }, "POLICY_MIN_TLS_1_2_PFS_2023_10": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy-Min-TLS-1-2-PFS-2023-10" } }, "POLICY_MIN_TLS_1_2_RFC9151_FIPS_2024_08": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08" } }, "POLICY_MIN_TLS_1_2_FIPS_PQ_2026_10": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy-Min-TLS-1-2-FIPS-PQ-2026-10" } } } }, "com.amazonaws.opensearch#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.opensearch#TagKey", "traits": { "smithy.api#documentation": "

The tag key. Tag keys must be unique for the domain to which they are attached.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.opensearch#TagValue", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A tag (key-value pair) for an Amazon OpenSearch Service resource.

" } }, "com.amazonaws.opensearch#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must\n be unique for the domain to which they're attached.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#TagList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#Tag" }, "traits": { "smithy.api#documentation": "

A list of tags attached to a domain.

" } }, "com.amazonaws.opensearch#TagValue": { "type": "string", "traits": { "smithy.api#documentation": "

A string between 0 to 256 characters that specifies the value for a tag. Tag values\n can be null and don't have to be unique in a tag set.

", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.opensearch#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

The request was denied due to request throttling. Reduce the frequency of your requests and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.opensearch#TimeUnit": { "type": "enum", "members": { "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOURS" } } }, "traits": { "smithy.api#documentation": "

The unit of a maintenance schedule duration. Valid value is HOUR.

" } }, "com.amazonaws.opensearch#Timestamp": { "type": "timestamp" }, "com.amazonaws.opensearch#TotalNumberOfStages": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.opensearch#TrafficPercent": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A traffic percentage from 0 to 100.

", "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.opensearch#TrafficPercents": { "type": "structure", "members": { "PrimaryReadTrafficPercent": { "target": "com.amazonaws.opensearch#TrafficPercent", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of search traffic sent to the primary cluster.

", "smithy.api#required": {} } }, "CloneReadTrafficPercent": { "target": "com.amazonaws.opensearch#TrafficPercent", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of search traffic sent to the cloned cluster.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The split of search traffic between the primary and cloned clusters.

" } }, "com.amazonaws.opensearch#TrafficSplitOptions": { "type": "structure", "members": { "Current": { "target": "com.amazonaws.opensearch#TrafficPercents", "traits": { "smithy.api#documentation": "

The traffic split currently in effect.

", "smithy.api#required": {} } }, "Target": { "target": "com.amazonaws.opensearch#TrafficPercents", "traits": { "smithy.api#documentation": "

The requested traffic split.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#TrafficSplitStatus", "traits": { "smithy.api#documentation": "

The status of the traffic shift.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The traffic split and status for a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#TrafficSplitRequestOptions": { "type": "structure", "members": { "Strategy": { "target": "com.amazonaws.opensearch#TrafficStrategy", "traits": { "smithy.api#documentation": "

The traffic shifting strategy. The only valid value is ShiftReadTrafficPercent.

", "smithy.api#required": {} } }, "CloneReadTrafficPercent": { "target": "com.amazonaws.opensearch#TrafficPercent", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of search traffic, from 0 to 100, to send to the cloned cluster. The rest goes to the primary cluster.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The traffic shift to perform for a cloned blue/green upgrade.

" } }, "com.amazonaws.opensearch#TrafficSplitStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } }, "traits": { "smithy.api#documentation": "

The status of a traffic shift.

" } }, "com.amazonaws.opensearch#TrafficStrategy": { "type": "enum", "members": { "SHIFT_READ_TRAFFIC_PERCENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ShiftReadTrafficPercent" } } }, "traits": { "smithy.api#documentation": "

The strategy used to shift traffic between the primary and cloned clusters.

" } }, "com.amazonaws.opensearch#UIntValue": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.opensearch#UncompressedPluginSizeInBytes": { "type": "long" }, "com.amazonaws.opensearch#UpdateApplication": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateApplicationRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateApplicationResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the configuration and settings of an existing OpenSearch application.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/application/{id}", "code": 200 } } }, "com.amazonaws.opensearch#UpdateApplicationRequest": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier for the OpenSearch application to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { "smithy.api#documentation": "

The data sources to associate with the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { "smithy.api#documentation": "

The configuration settings to modify for the OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptionsInput", "traits": { "smithy.api#documentation": "

Configuration settings for integrating IAM Identity Center with the OpenSearch\n application.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateApplicationResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.opensearch#Id", "traits": { "smithy.api#documentation": "

The unique identifier of the updated OpenSearch application.

" } }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the updated OpenSearch application.

" } }, "arn": { "target": "com.amazonaws.opensearch#ARN" }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { "smithy.api#documentation": "

The data sources associated with the updated OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", "traits": { "smithy.api#documentation": "

The IAM Identity Center configuration for the updated OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { "smithy.api#documentation": "

The configuration settings for the updated OpenSearch application.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the OpenSearch application was originally created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the OpenSearch application was last updated.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateClone": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateCloneRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateCloneResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Manages a cloned blue/green upgrade that is in progress on a domain. Use it to shift a percentage of search traffic to the cloned cluster, to cut over to the cloned cluster or back to the primary cluster, or to change the retention period. Specify exactly one of TrafficSplitOptions, CutoverOptions, or RetentionOptions in each request.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/clone", "code": 200 } } }, "com.amazonaws.opensearch#UpdateCloneRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain that has a cloned blue/green upgrade in progress.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TrafficSplitOptions": { "target": "com.amazonaws.opensearch#TrafficSplitRequestOptions", "traits": { "smithy.api#documentation": "

Shifts a percentage of search traffic from the primary cluster to the cloned cluster.

" } }, "CutoverOptions": { "target": "com.amazonaws.opensearch#CutoverRequestOptions", "traits": { "smithy.api#documentation": "

Cuts the domain over to the cloned cluster or back to the primary cluster.

" } }, "RetentionOptions": { "target": "com.amazonaws.opensearch#RetentionOptions", "traits": { "smithy.api#documentation": "

Changes the retention period, or ends it after cutover completes.

" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the UpdateClone operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateCloneResponse": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#required": {} } }, "ChangeId": { "target": "com.amazonaws.opensearch#GUID", "traits": { "smithy.api#documentation": "

The unique identifier of the configuration change. Use it with DescribeDomainChangeProgress to track the change.

", "smithy.api#required": {} } }, "CutoverOptions": { "target": "com.amazonaws.opensearch#CutoverOptions", "traits": { "smithy.api#documentation": "

The requested cutover target and the status of the cutover.

" } }, "TrafficSplitOptions": { "target": "com.amazonaws.opensearch#TrafficSplitOptions", "traits": { "smithy.api#documentation": "

The current and requested traffic split, and the status of the traffic shift.

" } }, "RetentionOptions": { "target": "com.amazonaws.opensearch#RetentionOptions", "traits": { "smithy.api#documentation": "

The retention settings for the upgrade.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the UpdateClone operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a direct-query data source. For more information, see Working\n with Amazon OpenSearch Service data source integrations with Amazon\n S3.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", "code": 200 } } }, "com.amazonaws.opensearch#UpdateDataSourceRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { "smithy.api#documentation": "

The name of the data source to modify.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DataSourceType", "traits": { "smithy.api#documentation": "

The type of data source.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#DataSourceDescription", "traits": { "smithy.api#documentation": "

A new description of the data source.

" } }, "Status": { "target": "com.amazonaws.opensearch#DataSourceStatus", "traits": { "smithy.api#documentation": "

The status of the data source update.

" } } }, "traits": { "smithy.api#documentation": "

Container for the parameters to the UpdateDataSource operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateDataSourceResponse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A message associated with the updated data source.

" } } }, "traits": { "smithy.api#documentation": "

The result of an UpdateDataSource operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateDirectQueryDataSource": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateDirectQueryDataSourceRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateDirectQueryDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the configuration or properties of an existing direct query data source in\n Amazon OpenSearch Service.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/directQueryDataSource/{DataSourceName}", "code": 200 } } }, "com.amazonaws.opensearch#UpdateDirectQueryDataSourceRequest": { "type": "structure", "members": { "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch\n Service environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { "smithy.api#documentation": "

The supported Amazon Web Services service that you want to use as the source for\n direct queries in OpenSearch Service.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { "smithy.api#documentation": "

An optional text field for providing additional context and details about the data\n source.

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { "smithy.api#documentation": "

An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are\n associated with the direct query data source. This field is required for CloudWatchLogs\n and SecurityLake datasource types.

" } }, "DataSourceAccessPolicy": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

An optional IAM access policy document that defines the updated permissions for accessing the direct query data source.\n The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateDirectQueryDataSourceResponse": { "type": "structure", "members": { "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateDomainConfig": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateDomainConfigRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateDomainConfigResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#InvalidTypeException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Modifies the cluster configuration of the specified Amazon OpenSearch Service\n domain.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/config", "code": 200 } } }, "com.amazonaws.opensearch#UpdateDomainConfigRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain that you're updating.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClusterConfig": { "target": "com.amazonaws.opensearch#ClusterConfig", "traits": { "smithy.api#documentation": "

Changes that you want to make to the cluster configuration, such as the instance type\n and number of EC2 instances.

" } }, "EBSOptions": { "target": "com.amazonaws.opensearch#EBSOptions", "traits": { "smithy.api#documentation": "

The type and size of the EBS volume to attach to instances in the domain.

" } }, "SnapshotOptions": { "target": "com.amazonaws.opensearch#SnapshotOptions", "traits": { "smithy.api#documentation": "

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

" } }, "VPCOptions": { "target": "com.amazonaws.opensearch#VPCOptions", "traits": { "smithy.api#documentation": "

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

" } }, "CognitoOptions": { "target": "com.amazonaws.opensearch#CognitoOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to configure Amazon Cognito authentication for OpenSearch\n Dashboards.

" } }, "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { "smithy.api#documentation": "

Key-value pairs to specify advanced configuration options. The following key-value\n pairs are supported:

\n \n

For more information, see Advanced cluster parameters.

" } }, "AccessPolicies": { "target": "com.amazonaws.opensearch#PolicyDocument", "traits": { "smithy.api#documentation": "

Identity and Access Management (IAM) access policy as a JSON-formatted string.

" } }, "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressType", "traits": { "smithy.api#documentation": "

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to\n share domain resources across IPv4 and IPv6 address types, and is the recommended\n option. If your IP address type is currently set to dual stack, you can't change it.\n

" } }, "LogPublishingOptions": { "target": "com.amazonaws.opensearch#LogPublishingOptions", "traits": { "smithy.api#documentation": "

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

" } }, "EncryptionAtRestOptions": { "target": "com.amazonaws.opensearch#EncryptionAtRestOptions", "traits": { "smithy.api#documentation": "

Encryption at rest options for the domain.

" } }, "DomainEndpointOptions": { "target": "com.amazonaws.opensearch#DomainEndpointOptions", "traits": { "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" } }, "NodeToNodeEncryptionOptions": { "target": "com.amazonaws.opensearch#NodeToNodeEncryptionOptions", "traits": { "smithy.api#documentation": "

Node-to-node encryption options for the domain.

" } }, "AdvancedSecurityOptions": { "target": "com.amazonaws.opensearch#AdvancedSecurityOptionsInput", "traits": { "smithy.api#documentation": "

Options for fine-grained access control.

" } }, "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsInput" }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptions", "traits": { "smithy.api#documentation": "

Options for Auto-Tune.

" } }, "DryRun": { "target": "com.amazonaws.opensearch#DryRun", "traits": { "smithy.api#documentation": "

This flag, when set to True, specifies whether the UpdateDomain request\n should return the results of a dry run analysis without actually applying the change. A\n dry run determines what type of deployment the update will cause.

" } }, "DryRunMode": { "target": "com.amazonaws.opensearch#DryRunMode", "traits": { "smithy.api#documentation": "

The type of dry run to perform.

\n " } }, "OffPeakWindowOptions": { "target": "com.amazonaws.opensearch#OffPeakWindowOptions", "traits": { "smithy.api#documentation": "

Off-peak window options for the domain.

" } }, "SoftwareUpdateOptions": { "target": "com.amazonaws.opensearch#SoftwareUpdateOptions", "traits": { "smithy.api#documentation": "

Service software update options for the domain.

" } }, "AIMLOptions": { "target": "com.amazonaws.opensearch#AIMLOptionsInput", "traits": { "smithy.api#documentation": "

Options for all machine learning features for the specified domain.

" } }, "DeploymentStrategyOptions": { "target": "com.amazonaws.opensearch#DeploymentStrategyOptions", "traits": { "smithy.api#documentation": "

Specifies the deployment strategy options for the domain.

" } }, "AutomatedSnapshotPauseOptions": { "target": "com.amazonaws.opensearch#AutomatedSnapshotPauseRequestOptions", "traits": { "smithy.api#documentation": "

Specifies the automated snapshot pause options for the domain.

\n \n

Suspending snapshots reduces data protection. You cannot restore your domain to\n points in time when snapshots are suspended. Use this feature only for short-term\n operational needs such as migrations or maintenance windows.

\n
\n

Maximum suspension duration: 3 days.

" } }, "UseCase": { "target": "com.amazonaws.opensearch#DomainUseCase", "traits": { "smithy.api#documentation": "

The primary use case for the domain. For valid values, see DomainUseCase.

" } }, "EngineMode": { "target": "com.amazonaws.opensearch#EngineMode", "traits": { "smithy.api#documentation": "

The engine mode for the domain. The engine mode can't be changed after the domain is created. For valid values, see EngineMode.

" } }, "AcceptedWarnings": { "target": "com.amazonaws.opensearch#AcceptedWarningsList", "traits": { "smithy.api#documentation": "

A list of advisory warning codes to accept for this configuration change. By default, any advisory warning blocks the change. Include the code of each warning you want to accept so the change can proceed. You can find warning codes in the ValidationFailures list returned by DescribeDomainChangeProgress and DescribeDryRunProgress. Critical validation failures cannot be accepted and always block the change. If you omit this parameter or pass an empty list, all warnings block the change. For more information, see Validating a domain update.

" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the UpdateDomain\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateDomainConfigResponse": { "type": "structure", "members": { "DomainConfig": { "target": "com.amazonaws.opensearch#DomainConfig", "traits": { "smithy.api#documentation": "

The status of the updated domain.

", "smithy.api#required": {} } }, "DryRunResults": { "target": "com.amazonaws.opensearch#DryRunResults", "traits": { "smithy.api#documentation": "

Results of the dry run performed in the update domain request.

" } }, "DryRunProgressStatus": { "target": "com.amazonaws.opensearch#DryRunProgressStatus", "traits": { "smithy.api#documentation": "

The status of the dry run being performed on the domain, if any.

" } } }, "traits": { "smithy.api#documentation": "

The results of an UpdateDomain request. Contains the status of the domain\n being updated.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateIndex": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateIndexRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateIndexResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#DependencyFailureException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ThrottlingException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}", "code": 200 } } }, "com.amazonaws.opensearch#UpdateIndexRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IndexName": { "target": "com.amazonaws.opensearch#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IndexSchema": { "target": "com.amazonaws.opensearch#IndexSchema", "traits": { "smithy.api#documentation": "

The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateIndexResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.opensearch#IndexStatus", "traits": { "smithy.api#documentation": "

The status of the index update operation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdatePackage": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdatePackageRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdatePackageResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#AccessDeniedException" }, { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a package for use with Amazon OpenSearch Service domains. For more\n information, see Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/update", "code": 200 } } }, "com.amazonaws.opensearch#UpdatePackageRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

The unique identifier for the package.

", "smithy.api#required": {} } }, "PackageSource": { "target": "com.amazonaws.opensearch#PackageSource", "traits": { "smithy.api#documentation": "

Amazon S3 bucket and key for the package.

", "smithy.api#required": {} } }, "PackageDescription": { "target": "com.amazonaws.opensearch#PackageDescription", "traits": { "smithy.api#documentation": "

A new description of the package.

" } }, "CommitMessage": { "target": "com.amazonaws.opensearch#CommitMessage", "traits": { "smithy.api#documentation": "

Commit message for the updated file, which is shown as part of\n GetPackageVersionHistoryResponse.

" } }, "PackageConfiguration": { "target": "com.amazonaws.opensearch#PackageConfiguration", "traits": { "smithy.api#documentation": "

The updated configuration details for a package.

" } }, "PackageEncryptionOptions": { "target": "com.amazonaws.opensearch#PackageEncryptionOptions", "traits": { "smithy.api#documentation": "

Encryption options for a package.

" } } }, "traits": { "smithy.api#documentation": "

Container for request parameters to the UpdatePackage operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdatePackageResponse": { "type": "structure", "members": { "PackageDetails": { "target": "com.amazonaws.opensearch#PackageDetails", "traits": { "smithy.api#documentation": "

Information about a package.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by the UpdatePackage\n operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdatePackageScope": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdatePackageScopeRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdatePackageScopeResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the scope of a package. Scope of the package defines users who can view and\n associate a package.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/updateScope", "code": 200 } } }, "com.amazonaws.opensearch#UpdatePackageScopeRequest": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

ID of the package whose scope is being updated.

", "smithy.api#required": {} } }, "Operation": { "target": "com.amazonaws.opensearch#PackageScopeOperationEnum", "traits": { "smithy.api#documentation": "

The operation to perform on the package scope (e.g., add/remove/override\n users).

", "smithy.api#required": {} } }, "PackageUserList": { "target": "com.amazonaws.opensearch#PackageUserList", "traits": { "smithy.api#documentation": "

List of users to be added or removed from the package scope.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdatePackageScopeResponse": { "type": "structure", "members": { "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { "smithy.api#documentation": "

ID of the package whose scope was updated.

" } }, "Operation": { "target": "com.amazonaws.opensearch#PackageScopeOperationEnum", "traits": { "smithy.api#documentation": "

The operation that was performed on the package scope.

" } }, "PackageUserList": { "target": "com.amazonaws.opensearch#PackageUserList", "traits": { "smithy.api#documentation": "

List of users who have access to the package after the scope update.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateScheduledAction": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateScheduledActionRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateScheduledActionResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#LimitExceededException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#SlotNotAvailableException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Reschedules a planned domain configuration change for a later time. This change can be\n a scheduled service\n software update or a blue/green Auto-Tune enhancement.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update", "code": 200 } } }, "com.amazonaws.opensearch#UpdateScheduledActionRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain to reschedule an action for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ActionID": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

", "smithy.api#required": {} } }, "ActionType": { "target": "com.amazonaws.opensearch#ActionType", "traits": { "smithy.api#documentation": "

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE,\n JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve\n this value, send a ListScheduledActions request.

", "smithy.api#required": {} } }, "ScheduleAt": { "target": "com.amazonaws.opensearch#ScheduleAt", "traits": { "smithy.api#documentation": "

When to schedule the action.

\n ", "smithy.api#required": {} } }, "DesiredStartTime": { "target": "com.amazonaws.opensearch#Long", "traits": { "smithy.api#documentation": "

The time to implement the change, in Coordinated Universal Time (UTC). Only specify\n this parameter if you set ScheduleAt to TIMESTAMP.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateScheduledActionResponse": { "type": "structure", "members": { "ScheduledAction": { "target": "com.amazonaws.opensearch#ScheduledAction", "traits": { "smithy.api#documentation": "

Information about the rescheduled action.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpdateTimestamp": { "type": "timestamp" }, "com.amazonaws.opensearch#UpdateVpcEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpdateVpcEndpointRequest" }, "output": { "target": "com.amazonaws.opensearch#UpdateVpcEndpointResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/vpcEndpoints/update", "code": 200 } } }, "com.amazonaws.opensearch#UpdateVpcEndpointRequest": { "type": "structure", "members": { "VpcEndpointId": { "target": "com.amazonaws.opensearch#VpcEndpointId", "traits": { "smithy.api#documentation": "

The unique identifier of the endpoint.

", "smithy.api#required": {} } }, "VpcOptions": { "target": "com.amazonaws.opensearch#VPCOptions", "traits": { "smithy.api#documentation": "

The security groups and/or subnets to add, remove, or modify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpdateVpcEndpointResponse": { "type": "structure", "members": { "VpcEndpoint": { "target": "com.amazonaws.opensearch#VpcEndpoint", "traits": { "smithy.api#documentation": "

The endpoint to be updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpgradeDomain": { "type": "operation", "input": { "target": "com.amazonaws.opensearch#UpgradeDomainRequest" }, "output": { "target": "com.amazonaws.opensearch#UpgradeDomainResponse" }, "errors": [ { "target": "com.amazonaws.opensearch#BaseException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" }, { "target": "com.amazonaws.opensearch#InternalException" }, { "target": "com.amazonaws.opensearch#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.opensearch#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearch#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/upgradeDomain", "code": 200 } } }, "com.amazonaws.opensearch#UpgradeDomainRequest": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

Name of the OpenSearch Service domain that you want to upgrade.

", "smithy.api#required": {} } }, "TargetVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

OpenSearch or Elasticsearch version to which you want to upgrade, in the format\n Opensearch_X.Y or Elasticsearch_X.Y.

", "smithy.api#required": {} } }, "PerformCheckOnly": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

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

" } }, "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { "smithy.api#documentation": "

Only supports the override_main_response_version parameter and not other\n advanced options. You can only include this option when upgrading to an OpenSearch\n version. Specifies whether the domain reports its version as 7.10 so that it continues\n to work with Elasticsearch OSS clients and plugins.

" } }, "DeploymentStrategyOptions": { "target": "com.amazonaws.opensearch#DeploymentStrategyOverrideOptions", "traits": { "smithy.api#documentation": "

Overrides the deployment strategy for this upgrade. To run a cloned blue/green upgrade, set DeploymentStrategy to ClonedBlueGreen.

" } } }, "traits": { "smithy.api#documentation": "

Container for the request parameters to the UpgradeDomain\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.opensearch#UpgradeDomainResponse": { "type": "structure", "members": { "UpgradeId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The unique identifier of the domain upgrade.

" } }, "DomainName": { "target": "com.amazonaws.opensearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain that was upgraded.

" } }, "TargetVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

OpenSearch or Elasticsearch version that the domain was upgraded to.

" } }, "PerformCheckOnly": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

When true, indicates that an upgrade eligibility check was performed.

" } }, "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { "smithy.api#documentation": "

The advanced options configuration for the domain.

" } }, "DeploymentStrategyOptions": { "target": "com.amazonaws.opensearch#DeploymentStrategyOverrideOptions", "traits": { "smithy.api#documentation": "

The deployment strategy override used for the upgrade.

" } }, "ChangeProgressDetails": { "target": "com.amazonaws.opensearch#ChangeProgressDetails", "traits": { "smithy.api#documentation": "

Container for information about a configuration change happening on a domain.

" } } }, "traits": { "smithy.api#documentation": "

Container for the response returned by UpgradeDomain operation.

", "smithy.api#output": {} } }, "com.amazonaws.opensearch#UpgradeHistory": { "type": "structure", "members": { "UpgradeName": { "target": "com.amazonaws.opensearch#UpgradeName", "traits": { "smithy.api#documentation": "

A string that describes the upgrade.

" } }, "StartTimestamp": { "target": "com.amazonaws.opensearch#StartTimestamp", "traits": { "smithy.api#documentation": "

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

" } }, "UpgradeStatus": { "target": "com.amazonaws.opensearch#UpgradeStatus", "traits": { "smithy.api#documentation": "

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

\n " } }, "StepsList": { "target": "com.amazonaws.opensearch#UpgradeStepsList", "traits": { "smithy.api#documentation": "

A list of each step performed as part of a specific upgrade or upgrade eligibility\n check.

" } } }, "traits": { "smithy.api#documentation": "

History of the last 10 upgrades and upgrade eligibility checks for an Amazon\n OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#UpgradeHistoryList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#UpgradeHistory" } }, "com.amazonaws.opensearch#UpgradeName": { "type": "string" }, "com.amazonaws.opensearch#UpgradeStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "SUCCEEDED_WITH_ISSUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED_WITH_ISSUES" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.opensearch#UpgradeStep": { "type": "enum", "members": { "PRE_UPGRADE_CHECK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_UPGRADE_CHECK" } }, "SNAPSHOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPSHOT" } }, "UPGRADE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPGRADE" } } } }, "com.amazonaws.opensearch#UpgradeStepItem": { "type": "structure", "members": { "UpgradeStep": { "target": "com.amazonaws.opensearch#UpgradeStep", "traits": { "smithy.api#documentation": "

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

\n " } }, "UpgradeStepStatus": { "target": "com.amazonaws.opensearch#UpgradeStatus", "traits": { "smithy.api#documentation": "

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

\n " } }, "Issues": { "target": "com.amazonaws.opensearch#Issues", "traits": { "smithy.api#documentation": "

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

" } }, "ProgressPercent": { "target": "com.amazonaws.opensearch#Double", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#UpgradeStepsList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#UpgradeStepItem" } }, "com.amazonaws.opensearch#UseCaseStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#DomainUseCase", "traits": { "smithy.api#documentation": "

The use case configured for the domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The current status of the use case for the domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of the use case for the domain.

" } }, "com.amazonaws.opensearch#UserPoolId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 55 }, "smithy.api#pattern": "^[\\w-]+_[0-9a-zA-Z]+$" } }, "com.amazonaws.opensearch#Username": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.opensearch#VPCDerivedInfo": { "type": "structure", "members": { "VPCId": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

" } }, "SubnetIds": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

A list of subnet IDs associated with the VPC endpoints for the domain.

" } }, "AvailabilityZones": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

The list of Availability Zones associated with the VPC subnets.

" } }, "SecurityGroupIds": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

The list of security group IDs associated with the VPC endpoints for the\n domain.

" } }, "EgressEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether egress traffic from the domain is routed through the customer VPC.\n When true, outbound traffic flows through the VPC. When\n false, outbound traffic goes through the public internet.

" } } }, "traits": { "smithy.api#documentation": "

Information about the subnets and security groups for an Amazon OpenSearch Service\n domain provisioned within a virtual private cloud (VPC). For more information, see\n Launching your Amazon OpenSearch Service domains using a VPC. This\n information only exists if the domain was created with VPCOptions.

" } }, "com.amazonaws.opensearch#VPCDerivedInfoStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#VPCDerivedInfo", "traits": { "smithy.api#documentation": "

The VPC options for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the VPC options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Status of the VPC options for a specified domain.

" } }, "com.amazonaws.opensearch#VPCOptions": { "type": "structure", "members": { "SubnetIds": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses\n multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide\n only one.

" } }, "SecurityGroupIds": { "target": "com.amazonaws.opensearch#StringList", "traits": { "smithy.api#documentation": "

The list of security group IDs associated with the VPC endpoints for the domain. If\n you do not provide a security group ID, OpenSearch Service uses the default security\n group for the VPC.

" } }, "EgressEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { "smithy.api#documentation": "

Controls whether egress traffic from the domain is routed through the customer VPC.\n When true, outbound traffic flows through the VPC. When\n false, outbound traffic goes through the public internet.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.opensearch#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.opensearch#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the error.

" } } }, "traits": { "smithy.api#documentation": "

An exception for accessing or deleting a resource that doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.opensearch#ValidationFailure": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The error code of the failure.

" } }, "Message": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A message corresponding to the failure.

" } }, "Severity": { "target": "com.amazonaws.opensearch#ValidationFailureSeverity", "traits": { "smithy.api#documentation": "

The severity of the validation failure.

" } } }, "traits": { "smithy.api#documentation": "

A validation failure that occurred as the result of a pre-update validation check\n (verbose dry run) on a domain.

" } }, "com.amazonaws.opensearch#ValidationFailureSeverity": { "type": "enum", "members": { "CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Critical" } }, "WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Warning" } } } }, "com.amazonaws.opensearch#ValidationFailures": { "type": "list", "member": { "target": "com.amazonaws.opensearch#ValidationFailure" } }, "com.amazonaws.opensearch#ValueStringList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#NonEmptyString" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.opensearch#VersionList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#VersionString" }, "traits": { "smithy.api#documentation": "

List of supported OpenSearch versions.

" } }, "com.amazonaws.opensearch#VersionStatus": { "type": "structure", "members": { "Options": { "target": "com.amazonaws.opensearch#VersionString", "traits": { "smithy.api#documentation": "

The OpenSearch or Elasticsearch version for the specified domain.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { "smithy.api#documentation": "

The status of the version options for the specified domain.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The status of the the OpenSearch or Elasticsearch version options for the specified\n Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#VersionString": { "type": "string", "traits": { "smithy.api#length": { "min": 14, "max": 18 }, "smithy.api#pattern": "^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$" } }, "com.amazonaws.opensearch#VolumeSize": { "type": "string" }, "com.amazonaws.opensearch#VolumeType": { "type": "enum", "members": { "standard": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "standard" } }, "gp2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gp2" } }, "io1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "io1" } }, "gp3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gp3" } } }, "traits": { "smithy.api#documentation": "

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.

" } }, "com.amazonaws.opensearch#VpcEndpoint": { "type": "structure", "members": { "VpcEndpointId": { "target": "com.amazonaws.opensearch#VpcEndpointId", "traits": { "smithy.api#documentation": "

The unique identifier of the endpoint.

" } }, "VpcEndpointOwner": { "target": "com.amazonaws.opensearch#AWSAccount", "traits": { "smithy.api#documentation": "

The creator of the endpoint.

" } }, "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

" } }, "VpcOptions": { "target": "com.amazonaws.opensearch#VPCDerivedInfo", "traits": { "smithy.api#documentation": "

Options to specify the subnets and security groups for an Amazon OpenSearch Service\n VPC endpoint.

" } }, "Status": { "target": "com.amazonaws.opensearch#VpcEndpointStatus", "traits": { "smithy.api#documentation": "

The current status of the endpoint.

" } }, "Endpoint": { "target": "com.amazonaws.opensearch#Endpoint", "traits": { "smithy.api#documentation": "

The connection endpoint ID for connecting to the domain.

" } } }, "traits": { "smithy.api#documentation": "

The connection endpoint for connecting to an Amazon OpenSearch Service domain through\n a proxy.

" } }, "com.amazonaws.opensearch#VpcEndpointError": { "type": "structure", "members": { "VpcEndpointId": { "target": "com.amazonaws.opensearch#VpcEndpointId", "traits": { "smithy.api#documentation": "

The unique identifier of the endpoint.

" } }, "ErrorCode": { "target": "com.amazonaws.opensearch#VpcEndpointErrorCode", "traits": { "smithy.api#documentation": "

The code associated with the error.

" } }, "ErrorMessage": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

A message describing the error.

" } } }, "traits": { "smithy.api#documentation": "

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC\n endpoint.

" } }, "com.amazonaws.opensearch#VpcEndpointErrorCode": { "type": "enum", "members": { "ENDPOINT_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENDPOINT_NOT_FOUND" } }, "SERVER_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVER_ERROR" } } } }, "com.amazonaws.opensearch#VpcEndpointErrorList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#VpcEndpointError" } }, "com.amazonaws.opensearch#VpcEndpointId": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 256 }, "smithy.api#pattern": "^aos-[a-zA-Z0-9]*$" } }, "com.amazonaws.opensearch#VpcEndpointIdList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#VpcEndpointId" } }, "com.amazonaws.opensearch#VpcEndpointStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } } }, "com.amazonaws.opensearch#VpcEndpointSummary": { "type": "structure", "members": { "VpcEndpointId": { "target": "com.amazonaws.opensearch#VpcEndpointId", "traits": { "smithy.api#documentation": "

The unique identifier of the endpoint.

" } }, "VpcEndpointOwner": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The creator of the endpoint.

" } }, "DomainArn": { "target": "com.amazonaws.opensearch#DomainArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

" } }, "Status": { "target": "com.amazonaws.opensearch#VpcEndpointStatus", "traits": { "smithy.api#documentation": "

The current status of the endpoint.

" } } }, "traits": { "smithy.api#documentation": "

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

" } }, "com.amazonaws.opensearch#VpcEndpointSummaryList": { "type": "list", "member": { "target": "com.amazonaws.opensearch#VpcEndpointSummary" } }, "com.amazonaws.opensearch#VpcEndpoints": { "type": "list", "member": { "target": "com.amazonaws.opensearch#VpcEndpoint" } }, "com.amazonaws.opensearch#WindowStartTime": { "type": "structure", "members": { "Hours": { "target": "com.amazonaws.opensearch#StartTimeHours", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time.\n For example, 17 refers to 5:00 P.M. UTC.

", "smithy.api#required": {} } }, "Minutes": { "target": "com.amazonaws.opensearch#StartTimeMinutes", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The start minute of the window, in UTC.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The desired start time for an off-peak\n maintenance window.

" } }, "com.amazonaws.opensearch#WorkspaceConfigurationInput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The name of the workspace to create. Must be between 1 and 40 characters and can contain alphanumeric characters, parentheses, brackets, hyphens, underscores, and spaces.

", "smithy.api#required": {} } }, "workspaceType": { "target": "com.amazonaws.opensearch#String", "traits": { "smithy.api#documentation": "

The type of workspace to create, which determines the use-case features enabled for the workspace. Valid values are OBSERVABILITY, SECURITY_ANALYTICS, and SEARCH.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration for creating a new workspace when attaching a data source to an OpenSearch application. The workspace is created after the data source is successfully attached.

" } }, "com.amazonaws.opensearch#ZoneAwarenessConfig": { "type": "structure", "members": { "AvailabilityZoneCount": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { "smithy.api#documentation": "

If you enabled multiple Availability Zones, this value is the number of zones that you\n want the domain to use. Valid values are 2 and 3. If your\n domain is provisioned within a VPC, this value be equal to number of subnets.

" } } }, "traits": { "smithy.api#documentation": "

The zone awareness configuration for an Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#ZoneStatus": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "StandBy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StandBy" } }, "NotAvailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotAvailable" } } } } } }