Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
Protocol or Cipher.
Name:
allOf:
- $ref: '#/components/schemas/DirectoryConfigurationSettingName'
- description: The name of the directory setting. For example:
TLS_1_0
Failed.
RequestDetailedStatus:
allOf:
- $ref: '#/components/schemas/DirectoryConfigurationSettingRequestDetailedStatus'
- description: Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.
RequestStatusMessage:
allOf:
- $ref: '#/components/schemas/DirectoryConfigurationSettingRequestStatusMessage'
- description: The last status message for the directory status request.
LastUpdatedDateTime:
allOf:
- $ref: '#/components/schemas/DirectoryConfigurationSettingLastUpdatedDateTime'
- description: The date and time when the directory setting was last updated.
LastRequestedDateTime:
allOf:
- $ref: '#/components/schemas/DirectoryConfigurationSettingLastRequestedDateTime'
- description: The date and time when the request to update a directory setting was last submitted.
description: Contains information about the specified configurable setting for a directory.
DirectoryConfigurationSettingLastUpdatedDateTime:
type: string
format: date-time
SettingEntries:
type: array
items:
$ref: '#/components/schemas/SettingEntry'
ClientException: {}
DirectoryConfigurationSettingName:
type: string
pattern: ^[a-zA-Z0-9-/. _]*$
minLength: 1
maxLength: 255
DescribeSettingsResult:
type: object
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory.
SettingEntries:
allOf:
- $ref: '#/components/schemas/SettingEntries'
- description: The list of SettingEntry objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items. '
DirectoryId:
type: string
pattern: ^d-[0-9a-f]{10}$
DescribeSettingsRequest:
type: object
required:
- DirectoryId
title: DescribeSettingsRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory for which to retrieve information.
Status:
allOf:
- $ref: '#/components/schemas/DirectoryConfigurationStatus'
- description: The status of the directory settings for which to retrieve information.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.
DirectoryConfigurationSettingValue:
type: string
pattern: ^[a-zA-Z0-9]*$
minLength: 1
maxLength: 255
DirectoryConfigurationStatus:
type: string
enum:
- Requested
- Updating
- Updated
- Failed
- Default
DirectoryConfigurationSettingRequestDetailedStatus:
type: object
additionalProperties:
$ref: '#/components/schemas/DirectoryConfigurationStatus'
UnsupportedOperationException: {}
DirectoryDoesNotExistException: {}
NextToken:
type: string
ServiceException: {}
DirectoryConfigurationSettingRequestStatusMessage:
type: string
InvalidParameterException: {}
DirectoryConfigurationSettingAllowedValues:
type: string
DirectoryConfigurationSettingType:
type: string
DirectoryConfigurationSettingLastRequestedDateTime:
type: string
format: date-time
InvalidNextTokenException: {}
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/ds/
x-hasEquivalentPaths: true