Response Syntax Response Elements Errors Examples See Also

DescribeAccountAttributes

Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.

This command does not take any parameters.

Response Syntax


{
   "AccountQuotas": [ 
      { 
         "AccountQuotaName": "string",
         "Max": number,
         "Used": number
      }
   ],
   "UniqueAccountIdentifier": "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.

AccountQuotas

Account quota information.

Type: Array of AccountQuota objects

UniqueAccountIdentifier

A unique AWS DMS identifier for an account in a particular AWS Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given AWS Region. The format of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3 bucket: dms-111122223333-c44445555666.

Note

AWS DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.

Type: String

Errors

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

Examples

Example

This example illustrates one usage of DescribeAccountAttributes.

Sample Request


   
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 
Credential=<Credential>, 
SignedHeaders=contenttype;date;host;user-
agent;x-amz-date;x-amz-target;x-amzn-
requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.DescribeAccountAttributes

Sample Response



 HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
   "AccountQuotas":[
      {
         "Max":20,
         "AccountQuotaName":"ReplicationInstances",
         "Used":12
      },
      {
         "Max":10000,
         "AccountQuotaName":"AllocatedStorage",
         "Used":6339
      },
      {
         "Max":20,
         "AccountQuotaName":"ReplicationSubnetGroups",
         "Used":5
      },
      {
         "Max":20,
         "AccountQuotaName":"SubnetsPerReplicationSubnetGroup",
         "Used":4
      },
      {
         "Max":100,
         "AccountQuotaName":"Endpoints",
         "Used":10
      },
      {
         "Max":200,
         "AccountQuotaName":"ReplicationTasks",
         "Used":2
      },
      {
         "Max":20,
         "AccountQuotaName":"EndpointsPerInstance",
         "Used":8
      }
   ]
   "UniqueAccountIdentifier":"c44445555666"
}