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

ListAppliedSchemaArns

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

Request Syntax


POST /amazonclouddirectory/2017-01-11/schema/applied HTTP/1.1
Content-type: application/json

{
   "DirectoryArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SchemaArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DirectoryArn

The ARN of the directory you are listing.

Type: String

Required: Yes

MaxResults

The maximum number of results to retrieve.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

The pagination token.

Type: String

Required: No

SchemaArn

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SchemaArns": [ "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.

NextToken

The pagination token.

Type: String

SchemaArns

The ARNs of schemas that are applied to the directory.

Type: Array of strings

Errors

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

AccessDeniedException

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

HTTP Status Code: 403

InternalServiceException

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

HTTP Status Code: 500

InvalidArnException

Indicates that the provided ARN value is not valid.

HTTP Status Code: 400

InvalidNextTokenException

Indicates that the NextToken value is not valid.

HTTP Status Code: 400

LimitExceededException

Indicates that limits are exceeded. See Limits for more information.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

RetryableConflictException

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409

ValidationException

Indicates that your request is malformed in some manner. See the exception message.

HTTP Status Code: 400

Examples

The following examples are formatted for legibility.

Example Request

This example illustrates one usage of ListAppliedSchemaArns.


POST /amazonclouddirectory/2017-01-11/schema/applied HTTP/1.1
Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 99
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171016/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-date, Signature=9263dc9a99c8cd1178f6305dfb28c6d95f9c273b4d7cab78aaf1d7934b1dce9f
X-Amz-Date: 20171016T225524Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8

{
	"DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY"
}

Example Response

This example illustrates one usage of ListAppliedSchemaArns.


HTTP/1.1 200 OK
x-amzn-RequestId: 1920f0d5-b2c5-11e7-a973-b71cf1107b43
Date: Mon, 16 Oct 2017 22:55:25 GMT
x-amzn-RequestId: 1920f0d5-b2c5-11e7-a973-b71cf1107b43
Content-Type: application/json
Content-Length: 128

{
	"NextToken": null,
	"SchemaArns": ["arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"]
}