{
"version":"2.0",
"metadata":{
"apiVersion":"2015-04-16",
"endpointPrefix":"ds",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"Directory Service",
"serviceFullName":"AWS Directory Service",
"signatureVersion":"v4",
"targetPrefix":"DirectoryService_20150416",
"uid":"ds-2015-04-16"
},
"operations":{
"AddIpRoutes":{
"name":"AddIpRoutes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddIpRoutesRequest"},
"output":{"shape":"AddIpRoutesResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"InvalidParameterException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"IpRouteLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. <i>AddIpRoutes</i> adds this address block. You can also use <i>AddIpRoutes</i> to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. </p> <p>Before you call <i>AddIpRoutes</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>AddIpRoutes</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"AddTagsToResource":{
"name":"AddTagsToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToResourceRequest"},
"output":{"shape":"AddTagsToResourceResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"TagLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.</p>"
},
"CancelSchemaExtension":{
"name":"CancelSchemaExtension",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelSchemaExtensionRequest"},
"output":{"shape":"CancelSchemaExtensionResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; <code>Initializing</code>, <code>CreatingSnapshot</code>, and <code>UpdatingSchema</code>.</p>"
},
"ConnectDirectory":{
"name":"ConnectDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConnectDirectoryRequest"},
"output":{"shape":"ConnectDirectoryResult"},
"errors":[
{"shape":"DirectoryLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates an AD Connector to connect to an on-premises directory.</p> <p>Before you call <i>ConnectDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>ConnectDirectory</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"CreateAlias":{
"name":"CreateAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateAliasRequest"},
"output":{"shape":"CreateAliasResult"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<alias>.awsapps.com</code>.</p> <important> <p>After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.</p> </important>"
},
"CreateComputer":{
"name":"CreateComputer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateComputerRequest"},
"output":{"shape":"CreateComputerResult"},
"errors":[
{"shape":"AuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a computer account in the specified directory, and joins the computer to the directory.</p>"
},
"CreateConditionalForwarder":{
"name":"CreateConditionalForwarder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConditionalForwarderRequest"},
"output":{"shape":"CreateConditionalForwarderResult"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.</p>"
},
"CreateDirectory":{
"name":"CreateDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDirectoryRequest"},
"output":{"shape":"CreateDirectoryResult"},
"errors":[
{"shape":"DirectoryLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a Simple AD directory.</p> <p>Before you call <i>CreateDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateDirectory</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"CreateMicrosoftAD":{
"name":"CreateMicrosoftAD",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateMicrosoftADRequest"},
"output":{"shape":"CreateMicrosoftADResult"},
"errors":[
{"shape":"DirectoryLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Creates a Microsoft AD in the AWS cloud.</p> <p>Before you call <i>CreateMicrosoftAD</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateMicrosoftAD</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"CreateSnapshot":{
"name":"CreateSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSnapshotRequest"},
"output":{"shape":"CreateSnapshotResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"SnapshotLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.</p> <note> <p>You cannot take snapshots of AD Connector directories.</p> </note>"
},
"CreateTrust":{
"name":"CreateTrust",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTrustRequest"},
"output":{"shape":"CreateTrustResult"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.</p> <p>This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.</p>"
},
"DeleteConditionalForwarder":{
"name":"DeleteConditionalForwarder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConditionalForwarderRequest"},
"output":{"shape":"DeleteConditionalForwarderResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Deletes a conditional forwarder that has been set up for your AWS directory.</p>"
},
"DeleteDirectory":{
"name":"DeleteDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDirectoryRequest"},
"output":{"shape":"DeleteDirectoryResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Deletes an AWS Directory Service directory.</p> <p>Before you call <i>DeleteDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>DeleteDirectory</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"DeleteSnapshot":{
"name":"DeleteSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSnapshotRequest"},
"output":{"shape":"DeleteSnapshotResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Deletes a directory snapshot.</p>"
},
"DeleteTrust":{
"name":"DeleteTrust",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTrustRequest"},
"output":{"shape":"DeleteTrustResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.</p>"
},
"DeregisterEventTopic":{
"name":"DeregisterEventTopic",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterEventTopicRequest"},
"output":{"shape":"DeregisterEventTopicResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Removes the specified directory as a publisher to the specified SNS topic.</p>"
},
"DescribeConditionalForwarders":{
"name":"DescribeConditionalForwarders",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConditionalForwardersRequest"},
"output":{"shape":"DescribeConditionalForwardersResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about the conditional forwarders for this account.</p> <p>If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.</p>"
},
"DescribeDirectories":{
"name":"DescribeDirectories",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDirectoriesRequest"},
"output":{"shape":"DescribeDirectoriesResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about the directories that belong to this account.</p> <p>You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items.</p> <p>You can also specify a maximum number of return results with the <i>Limit</i> parameter.</p>"
},
"DescribeEventTopics":{
"name":"DescribeEventTopics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventTopicsRequest"},
"output":{"shape":"DescribeEventTopicsResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about which SNS topics receive status messages from the specified directory.</p> <p>If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.</p>"
},
"DescribeSnapshots":{
"name":"DescribeSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSnapshotsRequest"},
Loading ...