DescribeDomainConfig
Returns the configuration of an Amazon OpenSearch Service domain.
Request Syntax
GET /2021-01-01/opensearch/domain/DomainName/config HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
Name of the OpenSearch Service domain configuration that you want to describe.
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DomainConfig": {
"AccessPolicies": {
"Options": "string",
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"AdvancedOptions": {
"Options": {
"string" : "string"
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"AdvancedSecurityOptions": {
"Options": {
"AnonymousAuthDisableDate": number,
"AnonymousAuthEnabled": boolean,
"Enabled": boolean,
"InternalUserDatabaseEnabled": boolean,
"SAMLOptions": {
"Enabled": boolean,
"Idp": {
"EntityId": "string",
"MetadataContent": "string"
},
"RolesKey": "string",
"SessionTimeoutMinutes": number,
"SubjectKey": "string"
}
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"AutoTuneOptions": {
"Options": {
"DesiredState": "string",
"MaintenanceSchedules": [
{
"CronExpressionForRecurrence": "string",
"Duration": {
"Unit": "string",
"Value": number
},
"StartAt": number
}
],
"RollbackOnDisable": "string",
"UseOffPeakWindow": boolean
},
"Status": {
"CreationDate": number,
"ErrorMessage": "string",
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"ChangeProgressDetails": {
"ChangeId": "string",
"Message": "string"
},
"ClusterConfig": {
"Options": {
"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
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"CognitoOptions": {
"Options": {
"Enabled": boolean,
"IdentityPoolId": "string",
"RoleArn": "string",
"UserPoolId": "string"
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"DomainEndpointOptions": {
"Options": {
"CustomEndpoint": "string",
"CustomEndpointCertificateArn": "string",
"CustomEndpointEnabled": boolean,
"EnforceHTTPS": boolean,
"TLSSecurityPolicy": "string"
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"EBSOptions": {
"Options": {
"EBSEnabled": boolean,
"Iops": number,
"Throughput": number,
"VolumeSize": number,
"VolumeType": "string"
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"EncryptionAtRestOptions": {
"Options": {
"Enabled": boolean,
"KmsKeyId": "string"
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"EngineVersion": {
"Options": "string",
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"IPAddressType": {
"Options": "string",
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"LogPublishingOptions": {
"Options": {
"string" : {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
}
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"NodeToNodeEncryptionOptions": {
"Options": {
"Enabled": boolean
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"OffPeakWindowOptions": {
"Options": {
"Enabled": boolean,
"OffPeakWindow": {
"WindowStartTime": {
"Hours": number,
"Minutes": number
}
}
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"SnapshotOptions": {
"Options": {
"AutomatedSnapshotStartHour": number
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"SoftwareUpdateOptions": {
"Options": {
"AutoSoftwareUpdateEnabled": boolean
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
},
"VPCOptions": {
"Options": {
"AvailabilityZones": [ "string" ],
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VPCId": "string"
},
"Status": {
"CreationDate": number,
"PendingDeletion": boolean,
"State": "string",
"UpdateDate": number,
"UpdateVersion": number
}
}
}
}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.
- DomainConfig
-
Container for the configuration of the OpenSearch Service domain.
Type: DomainConfig object
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
- ResourceNotFoundException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 409
- ValidationException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
