Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDomains

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

Request Syntax


POST /2021-01-01/opensearch/domain-info HTTP/1.1
Content-type: application/json

{
   "DomainNames": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DomainNames

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

Type: Array of strings

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DomainStatusList": [ 
      { 
         "AccessPolicies": "string",
         "AdvancedOptions": { 
            "string" : "string" 
         },
         "AdvancedSecurityOptions": { 
            "AnonymousAuthDisableDate": number,
            "AnonymousAuthEnabled": boolean,
            "Enabled": boolean,
            "InternalUserDatabaseEnabled": boolean,
            "SAMLOptions": { 
               "Enabled": boolean,
               "Idp": { 
                  "EntityId": "string",
                  "MetadataContent": "string"
               },
               "RolesKey": "string",
               "SessionTimeoutMinutes": number,
               "SubjectKey": "string"
            }
         },
         "ARN": "string",
         "AutoTuneOptions": { 
            "ErrorMessage": "string",
            "State": "string",
            "UseOffPeakWindow": boolean
         },
         "ChangeProgressDetails": { 
            "ChangeId": "string",
            "Message": "string"
         },
         "ClusterConfig": { 
            "ColdStorageOptions": { 
               "Enabled": boolean
            },
            "DedicatedMasterCount": number,
            "DedicatedMasterEnabled": boolean,
            "DedicatedMasterType": "string",
            "InstanceCount": number,
            "InstanceType": "string",
            "MultiAZWithStandbyEnabled": boolean,
            "WarmCount": number,
            "WarmEnabled": boolean,
            "WarmType": "string",
            "ZoneAwarenessConfig": { 
               "AvailabilityZoneCount": number
            },
            "ZoneAwarenessEnabled": boolean
         },
         "CognitoOptions": { 
            "Enabled": boolean,
            "IdentityPoolId": "string",
            "RoleArn": "string",
            "UserPoolId": "string"
         },
         "Created": boolean,
         "Deleted": boolean,
         "DomainEndpointOptions": { 
            "CustomEndpoint": "string",
            "CustomEndpointCertificateArn": "string",
            "CustomEndpointEnabled": boolean,
            "EnforceHTTPS": boolean,
            "TLSSecurityPolicy": "string"
         },
         "DomainId": "string",
         "DomainName": "string",
         "EBSOptions": { 
            "EBSEnabled": boolean,
            "Iops": number,
            "Throughput": number,
            "VolumeSize": number,
            "VolumeType": "string"
         },
         "EncryptionAtRestOptions": { 
            "Enabled": boolean,
            "KmsKeyId": "string"
         },
         "Endpoint": "string",
         "Endpoints": { 
            "string" : "string" 
         },
         "EndpointV2": "string",
         "EngineVersion": "string",
         "IPAddressType": "string",
         "LogPublishingOptions": { 
            "string" : { 
               "CloudWatchLogsLogGroupArn": "string",
               "Enabled": boolean
            }
         },
         "NodeToNodeEncryptionOptions": { 
            "Enabled": boolean
         },
         "OffPeakWindowOptions": { 
            "Enabled": boolean,
            "OffPeakWindow": { 
               "WindowStartTime": { 
                  "Hours": number,
                  "Minutes": number
               }
            }
         },
         "Processing": boolean,
         "ServiceSoftwareOptions": { 
            "AutomatedUpdateDate": number,
            "Cancellable": boolean,
            "CurrentVersion": "string",
            "Description": "string",
            "NewVersion": "string",
            "OptionalDeployment": boolean,
            "UpdateAvailable": boolean,
            "UpdateStatus": "string"
         },
         "SnapshotOptions": { 
            "AutomatedSnapshotStartHour": number
         },
         "SoftwareUpdateOptions": { 
            "AutoSoftwareUpdateEnabled": boolean
         },
         "UpgradeProcessing": boolean,
         "VPCOptions": { 
            "AvailabilityZones": [ "string" ],
            "SecurityGroupIds": [ "string" ],
            "SubnetIds": [ "string" ],
            "VPCId": "string"
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DomainStatusList

The status of the requested domains.

Type: Array of DomainStatus objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400