ListCertificates
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
Request Syntax
{
"DirectoryId": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DirectoryId (p. 131)
The identifier of the directory.
Type: String
Pattern: ^d-[0-9a-f]{10}$
Required: Yes Limit (p. 131)
The number of items that should show up on one page Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No NextToken (p. 131)
A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.
Type: String Required: No
Response Syntax
{
"CertificatesInfo": [ {
"CertificateId": "string", "CommonName": "string", "ExpiryDateTime": number, "State": "string",
"Type": "string"
Response Elements
} ],
"NextToken": "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.
CertificatesInfo (p. 131)
A list of certificates with basic details including certificate ID, certificate common name, certificate state.
Type: Array of CertificateInfo (p. 197) objects NextToken (p. 131)
Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 DirectoryDoesNotExistException
The specified directory does not exist in the system.
HTTP Status Code: 400 InvalidNextTokenException
The NextToken value is not valid.
HTTP Status Code: 400 InvalidParameterException
One or more parameters are not valid.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500 UnsupportedOperationException
The operation is not supported.
See Also
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListIpRoutes
ListIpRoutes
Lists the address blocks that you have added to a directory.
Request Syntax
{ "DirectoryId": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DirectoryId (p. 134)
Identifier (ID) of the directory for which you want to retrieve the IP addresses.
Type: String
Pattern: ^d-[0-9a-f]{10}$
Required: Yes Limit (p. 134)
Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
Type: Integer
Valid Range: Minimum value of 0.
Required: No NextToken (p. 134)
The ListIpRoutes.NextToken value from a previous call to ListIpRoutes (p. 134). Pass null if this is the first call.
Type: String Required: No
Response Syntax
{ "IpRoutesInfo": [ {
"AddedDateTime": number, "CidrIp": "string", "Description": "string", "DirectoryId": "string", "IpRouteStatusMsg": "string", "IpRouteStatusReason": "string"
}
Response Elements
],
"NextToken": "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.
IpRoutesInfo (p. 134)
A list of IpRoute (p. 220)s.
Type: Array of IpRouteInfo (p. 221) objects NextToken (p. 134)
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes (p. 134) to retrieve the next set of items.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
HTTP Status Code: 400 InvalidNextTokenException
The NextToken value is not valid.
HTTP Status Code: 400 InvalidParameterException
One or more parameters are not valid.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
Examples
The following examples are formatted for legibility.
See Also
Example Request
This example illustrates one usage of ListIpRoutes.
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 43
X-Amz-Target: DirectoryService_20150416.ListIpRoutes X-Amz-Date: 20161214T225328Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAI7E3BYXS3example/20161214/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=4dcb72aae179937790f5b061ceb1c697ac434b27891014b609671e49e52be1dd { "DirectoryId":"d-926example",
"Limit": 0 }
Example Response
This example illustrates one usage of ListIpRoutes.
HTTP/1.1 200 OK
x-amzn-RequestId: 2214ceaa-c250-11e6-a7ca-f9a52a6a0390 Content-Type: application/x-amz-json-1.1
Content-Length: 155
Date: Wed, 14 Dec 2016 22:53:30 GMT { "IpRoutesInfo":[
{
"AddedDateTime":1.48157763163E9, "CidrIp":"12.12.12.12/32", "Description":"example", "DirectoryId":"d-926example", "IpRouteStatusMsg":"Added"
} ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
ListLogSubscriptions
ListLogSubscriptions
Lists the active log subscriptions for the AWS account.
Request Syntax
{
"DirectoryId": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DirectoryId (p. 138)
If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.
Type: String
Pattern: ^d-[0-9a-f]{10}$
Required: No Limit (p. 138)
The maximum number of items returned.
Type: Integer
Valid Range: Minimum value of 0.
Required: No NextToken (p. 138)
The token for the next set of items to return.
Type: String Required: No
Response Syntax
{ "LogSubscriptions": [ {
"DirectoryId": "string", "LogGroupName": "string",
"SubscriptionCreatedDateTime": number }
],
"NextToken": "string"
Response Elements
}
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.
LogSubscriptions (p. 138)
A list of active LogSubscription (p. 224) objects for calling the AWS account.
Type: Array of LogSubscription (p. 224) objects NextToken (p. 138)
The token for the next set of items to return.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
HTTP Status Code: 400 InvalidNextTokenException
The NextToken value is not valid.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListSchemaExtensions
ListSchemaExtensions
Lists all schema extensions applied to a Microsoft AD Directory.
Request Syntax
{
"DirectoryId": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DirectoryId (p. 141)
The identifier of the directory from which to retrieve the schema extension information.
Type: String
Pattern: ^d-[0-9a-f]{10}$
Required: Yes Limit (p. 141)
The maximum number of items to return.
Type: Integer
Valid Range: Minimum value of 0.
Required: No NextToken (p. 141)
The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions.
Pass null if this is the first call.
Type: String Required: No
Response Syntax
{ "NextToken": "string", "SchemaExtensionsInfo": [ {
"Description": "string", "DirectoryId": "string", "EndDateTime": number,
"SchemaExtensionId": "string", "SchemaExtensionStatus": "string", "SchemaExtensionStatusReason": "string",
Response Elements
"StartDateTime": 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.
NextToken (p. 141)
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.
Type: String
SchemaExtensionsInfo (p. 141)
Information about the schema extensions applied to the directory.
Type: Array of SchemaExtensionInfo (p. 232) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
HTTP Status Code: 400 InvalidNextTokenException
The NextToken value is not valid.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of ListSchemaExtensions.
See Also
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 43
X-Amz-Target: DirectoryService_20150416.ListSchemaExtensions X-Amz-Date: 20161214T230332Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAI7E3BYXS3example/20161214/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=39aa3aec95444a9bf6dff7fc57d3178c9364b5d2fd560380e8fbc6eee13b3cf1 { "DirectoryId": "d-926example",
"Limit": 0 }
Example Response
This example illustrates one usage of ListSchemaExtensions.
HTTP/1.1 200 OK
x-amzn-RequestId: 89f9aea0-c251-11e6-b0d6-83af322c90cd Content-Type: application/x-amz-json-1.1
Content-Length: 333
Date: Wed, 14 Dec 2016 23:03:34 GMT { "SchemaExtensionsInfo":[
{
"Description":"example text", "DirectoryId":"d-926example", "EndDateTime":1.481586088301E9, "SchemaExtensionId":"e-926731d2a0", "SchemaExtensionStatus":"Cancelled",
"SchemaExtensionStatusReason":"Cancellation is complete. No schema updates were applied to your directory.",
"StartDateTime":1.481584463548E9 }
]}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
ListTagsForResource
ListTagsForResource
Lists all tags on a directory.
Request Syntax
{ "Limit": number, "NextToken": "string", "ResourceId": "string"
}
Request Parameters
The request accepts the following data in JSON format.
Limit (p. 145)
Reserved for future use.
Type: Integer
Valid Range: Minimum value of 0.
Required: No NextToken (p. 145)
Reserved for future use.
Type: String Required: No ResourceId (p. 145)
Identifier (ID) of the directory for which you want to retrieve tags.
Type: String
Pattern: ^[d]-[0-9a-f]{10}$
Required: Yes
Response Syntax
{
"NextToken": "string", "Tags": [
{
"Key": "string", "Value": "string"
} ]}
Response Elements
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.
NextToken (p. 145)
Reserved for future use.
Type: String Tags (p. 145)
List of tags returned by the ListTagsForResource operation.
Type: Array of Tag (p. 240) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
HTTP Status Code: 400 InvalidNextTokenException
The NextToken value is not valid.
HTTP Status Code: 400 InvalidParameterException
One or more parameters are not valid.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of ListTagsForResource.
See Also
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 42
X-Amz-Target: DirectoryService_20150416.ListTagsForResource X-Amz-Date: 20161214T231352Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAI7E3BYXS3example/20161214/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=72d8e8988d5a206b4e218f406544b06cb4f6fd9d8927a270317509c9861b0826 {
"ResourceId":"d-926example", "Limit": 0
}
Example Response
This example illustrates one usage of ListTagsForResource.
HTTP/1.1 200 OK
x-amzn-RequestId: fb7da12c-c252-11e6-a96d-2b0686697d23 Content-Type: application/x-amz-json-1.1
Content-Length: 53
Date: Wed, 14 Dec 2016 23:13:54 GMT { "Tags":[
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3