{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.directoryservice#ADAssessmentLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

A directory assessment is automatically created when you create a hybrid directory.\n There are two types of assessments: CUSTOMER and SYSTEM. Your\n Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

\n

If you attempt to create a hybrid directory; and you already have 100\n CUSTOMER directory assessments;, you will encounter an error. Delete\n assessments to free up capacity before trying again.

\n

You can request an increase to your CUSTOMER directory assessment quota\n by contacting customer support or delete existing CUSTOMER directory assessments; to\n free up capacity.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#AcceptSharedDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#AcceptSharedDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#AcceptSharedDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryAlreadySharedException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Accepts a directory sharing request that was sent from the directory owner account.

" } }, "com.amazonaws.directoryservice#AcceptSharedDirectoryRequest": { "type": "structure", "members": { "SharedDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the shared directory in the directory consumer account. This identifier is\n different for each directory owner account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#AcceptSharedDirectoryResult": { "type": "structure", "members": { "SharedDirectory": { "target": "com.amazonaws.directoryservice#SharedDirectory", "traits": { "smithy.api#documentation": "

The shared directory in the directory consumer account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#AccessUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.directoryservice#AddIpRoutes": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#AddIpRoutesRequest" }, "output": { "target": "com.amazonaws.directoryservice#AddIpRoutesResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#IpRouteLimitExceededException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

If the DNS server for your self-managed domain uses a publicly addressable IP address,\n you must add a CIDR address block to correctly route traffic to and from your Microsoft AD\n on Amazon Web Services. AddIpRoutes adds this address block. You can\n also use AddIpRoutes to facilitate routing traffic that uses public IP\n ranges from your Microsoft AD on Amazon Web Services to a peer VPC.

\n

Before you call AddIpRoutes, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what\n permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

", "smithy.api#examples": [ { "title": "To add a CIDR address block that routes traffic for Microsoft AD", "documentation": "The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.", "input": { "DirectoryId": "d-92654abfed", "IpRoutes": [ { "Description": "my IpRoute", "CidrIp": "12.12.12.12/32" } ] }, "output": {} } ] } }, "com.amazonaws.directoryservice#AddIpRoutesRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory to which to add the address block.

", "smithy.api#required": {} } }, "IpRoutes": { "target": "com.amazonaws.directoryservice#IpRoutes", "traits": { "smithy.api#documentation": "

IP address blocks, using CIDR format, of the traffic to route. This is often the IP\n address block of the DNS server used for your self-managed domain.

", "smithy.api#required": {} } }, "UpdateSecurityGroupForDirectoryControllers": { "target": "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has\n the description: \"Amazon Web Services created security group for directory ID\n directory controllers.\" Following are the new rules:

\n

Inbound:

\n \n

\n

Outbound:

\n \n

These security rules impact an internal network interface that is not exposed\n publicly.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#AddIpRoutesResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#AddRegion": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#AddRegionRequest" }, "output": { "target": "com.amazonaws.directoryservice#AddRegionResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryAlreadyInRegionException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#RegionLimitExceededException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Adds two domain controllers in the specified Region for the specified directory.

" } }, "com.amazonaws.directoryservice#AddRegionRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory to which you want to add Region replication.

", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { "smithy.api#documentation": "

The name of the Region where you want to add domain controllers for replication. For\n example, us-east-1.

", "smithy.api#required": {} } }, "VPCSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#AddRegionResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#AddTagsToResource": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#AddTagsToResourceRequest" }, "output": { "target": "com.amazonaws.directoryservice#AddTagsToResourceResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#TagLimitExceededException" } ], "traits": { "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified directory. Each directory can\n have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be\n unique to each resource.

", "smithy.api#examples": [ { "title": "To add tags to a directory", "documentation": "The following example adds or overwrites one or more tags for the specified directory.", "input": { "ResourceId": "d-92654abfed", "Tags": [ { "Key": "environment", "Value": "production" } ] }, "output": {} } ] } }, "com.amazonaws.directoryservice#AddTagsToResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.directoryservice#ResourceId", "traits": { "smithy.api#documentation": "

Identifier (ID) for the directory to which to add the tag.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

The tags to be assigned to the directory.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#AddTagsToResourceResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#AddedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#AdditionalRegions": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#RegionName" } }, "com.amazonaws.directoryservice#AliasName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 62 }, "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" } }, "com.amazonaws.directoryservice#Assessment": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The unique identifier of the directory assessment.

" } }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory associated with this assessment.

" } }, "DnsName": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory domain being\n assessed.

" } }, "StartTime": { "target": "com.amazonaws.directoryservice#AssessmentStartTime", "traits": { "smithy.api#documentation": "

The date and time when the assessment was initiated.

" } }, "LastUpdateDateTime": { "target": "com.amazonaws.directoryservice#LastUpdateDateTime", "traits": { "smithy.api#documentation": "

The date and time when the assessment status was last updated.

" } }, "Status": { "target": "com.amazonaws.directoryservice#AssessmentStatus", "traits": { "smithy.api#documentation": "

The current status of the assessment. Valid values include SUCCESS,\n FAILED, PENDING, and IN_PROGRESS.

" } }, "StatusCode": { "target": "com.amazonaws.directoryservice#AssessmentStatusCode", "traits": { "smithy.api#documentation": "

A detailed status code providing additional information about the assessment\n state.

" } }, "StatusReason": { "target": "com.amazonaws.directoryservice#AssessmentStatusReason", "traits": { "smithy.api#documentation": "

A human-readable description of the current assessment status, including any error\n details or progress information.

" } }, "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#CustomerDnsIps", "traits": { "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in your self-managed AD\n environment.

" } }, "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

Contains Amazon VPC information for the StartADAssessment operation.

" } }, "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { "smithy.api#documentation": "

A list of subnet identifiers in the Amazon VPC in which the hybrid directory is\n created.

" } }, "SecurityGroupIds": { "target": "com.amazonaws.directoryservice#SecurityGroupIds", "traits": { "smithy.api#documentation": "

The security groups identifiers attached to the network interfaces.

" } }, "SelfManagedInstanceIds": { "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", "traits": { "smithy.api#documentation": "

The identifiers of the self-managed AD instances used to perform the\n assessment.

" } }, "ReportType": { "target": "com.amazonaws.directoryservice#AssessmentReportType", "traits": { "smithy.api#documentation": "

The type of assessment report generated. Valid values are CUSTOMER and\n SYSTEM.

" } }, "Version": { "target": "com.amazonaws.directoryservice#AssessmentVersion", "traits": { "smithy.api#documentation": "

The version of the assessment framework used to evaluate your self-managed AD\n environment.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a directory assessment, including configuration\n parameters, status, and validation results.

" } }, "com.amazonaws.directoryservice#AssessmentConfiguration": { "type": "structure", "members": { "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#CustomerDnsIps", "traits": { "smithy.api#documentation": "

A list of IP addresses for the DNS servers or domain controllers in your self-managed\n AD that are tested during the assessment.

", "smithy.api#required": {} } }, "DnsName": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the self-managed AD domain to assess.

", "smithy.api#required": {} } }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", "traits": { "smithy.api#required": {} } }, "InstanceIds": { "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", "traits": { "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM that are used to perform\n connectivity and validation tests.

", "smithy.api#required": {} } }, "SecurityGroupIds": { "target": "com.amazonaws.directoryservice#SecurityGroupIds", "traits": { "smithy.api#documentation": "

By default, the service attaches a security group to allow network access to the\n self-managed nodes in your Amazon VPC. You can optionally supply your own security group that\n allows network traffic to and from your self-managed domain controllers outside of your\n Amazon VPC.

" } } }, "traits": { "smithy.api#documentation": "

Contains configuration parameters required to perform a directory assessment.

" } }, "com.amazonaws.directoryservice#AssessmentId": { "type": "string", "traits": { "smithy.api#pattern": "^da-[0-9a-f]{18}$" } }, "com.amazonaws.directoryservice#AssessmentInstanceId": { "type": "string", "traits": { "smithy.api#pattern": "^(i-[0-9a-f]{8}|i-[0-9a-f]{17}|mi-[0-9a-f]{8}|mi-[0-9a-f]{17})$" } }, "com.amazonaws.directoryservice#AssessmentInstanceIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#AssessmentInstanceId" }, "traits": { "smithy.api#length": { "min": 2, "max": 2 } } }, "com.amazonaws.directoryservice#AssessmentLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.directoryservice#AssessmentReport": { "type": "structure", "members": { "DomainControllerIp": { "target": "com.amazonaws.directoryservice#IpAddr", "traits": { "smithy.api#documentation": "

The IP address of the domain controller that was tested during the assessment.

" } }, "Validations": { "target": "com.amazonaws.directoryservice#AssessmentValidations", "traits": { "smithy.api#documentation": "

A list of validation results for different test categories performed against this\n domain controller.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of validation tests performed against a specific domain\n controller during a directory assessment.

" } }, "com.amazonaws.directoryservice#AssessmentReportType": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentReports": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#AssessmentReport" } }, "com.amazonaws.directoryservice#AssessmentStartTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#AssessmentStatus": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentStatusCode": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentSummary": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The unique identifier of the directory assessment.

" } }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory associated with this assessment.

" } }, "DnsName": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory domain being\n assessed.

" } }, "StartTime": { "target": "com.amazonaws.directoryservice#AssessmentStartTime", "traits": { "smithy.api#documentation": "

The date and time when the assessment was initiated.

" } }, "LastUpdateDateTime": { "target": "com.amazonaws.directoryservice#LastUpdateDateTime", "traits": { "smithy.api#documentation": "

The date and time when the assessment status was last updated.

" } }, "Status": { "target": "com.amazonaws.directoryservice#AssessmentStatus", "traits": { "smithy.api#documentation": "

The current status of the assessment. Valid values include SUCCESS,\n FAILED, PENDING, and IN_PROGRESS.

" } }, "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#CustomerDnsIps", "traits": { "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in your self-managed AD\n environment.

" } }, "ReportType": { "target": "com.amazonaws.directoryservice#AssessmentReportType", "traits": { "smithy.api#documentation": "

The type of assessment report generated. Valid values include CUSTOMER\n and SYSTEM.

" } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a directory assessment, providing a high-level\n overview without detailed validation results.

" } }, "com.amazonaws.directoryservice#AssessmentValidation": { "type": "structure", "members": { "Category": { "target": "com.amazonaws.directoryservice#AssessmentValidationCategory", "traits": { "smithy.api#documentation": "

The category of the validation test.

" } }, "Name": { "target": "com.amazonaws.directoryservice#AssessmentValidationName", "traits": { "smithy.api#documentation": "

The name of the specific validation test performed within the category.

" } }, "Status": { "target": "com.amazonaws.directoryservice#AssessmentValidationStatus", "traits": { "smithy.api#documentation": "

The result status of the validation test. Valid values include SUCCESS,\n FAILED, PENDING, and IN_PROGRESS.

" } }, "StatusCode": { "target": "com.amazonaws.directoryservice#AssessmentValidationStatusCode", "traits": { "smithy.api#documentation": "

A detailed status code providing additional information about the validation\n result.

" } }, "StatusReason": { "target": "com.amazonaws.directoryservice#AssessmentValidationStatusReason", "traits": { "smithy.api#documentation": "

A human-readable description of the validation result, including any error details or\n recommendations.

" } }, "StartTime": { "target": "com.amazonaws.directoryservice#AssessmentValidationTimeStamp", "traits": { "smithy.api#documentation": "

The date and time when the validation test was started.

" } }, "LastUpdateDateTime": { "target": "com.amazonaws.directoryservice#AssessmentValidationTimeStamp", "traits": { "smithy.api#documentation": "

The date and time when the validation test was completed or last updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a specific validation test performed during a directory\n assessment.

" } }, "com.amazonaws.directoryservice#AssessmentValidationCategory": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentValidationName": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentValidationStatus": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentValidationStatusCode": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentValidationStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#AssessmentValidationTimeStamp": { "type": "timestamp" }, "com.amazonaws.directoryservice#AssessmentValidations": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#AssessmentValidation" } }, "com.amazonaws.directoryservice#AssessmentVersion": { "type": "string" }, "com.amazonaws.directoryservice#Assessments": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#AssessmentSummary" } }, "com.amazonaws.directoryservice#Attribute": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.directoryservice#AttributeName", "traits": { "smithy.api#documentation": "

The name of the attribute.

" } }, "Value": { "target": "com.amazonaws.directoryservice#AttributeValue", "traits": { "smithy.api#documentation": "

The value of the attribute.

" } } }, "traits": { "smithy.api#documentation": "

Represents a named directory attribute.

" } }, "com.amazonaws.directoryservice#AttributeName": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.directoryservice#AttributeValue": { "type": "string" }, "com.amazonaws.directoryservice#Attributes": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Attribute" } }, "com.amazonaws.directoryservice#AuthenticationFailedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage", "traits": { "smithy.api#documentation": "

The textual message for the exception.

" } }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId", "traits": { "smithy.api#documentation": "

The identifier of the request that caused the exception.

" } } }, "traits": { "smithy.api#documentation": "

An authentication error occurred.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#AvailabilityZone": { "type": "string" }, "com.amazonaws.directoryservice#AvailabilityZones": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#AvailabilityZone" } }, "com.amazonaws.directoryservice#CaEnrollmentPolicyStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Success" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabling" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Impaired" } } } }, "com.amazonaws.directoryservice#CaEnrollmentPolicyStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#CancelSchemaExtension": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CancelSchemaExtensionRequest" }, "output": { "target": "com.amazonaws.directoryservice#CancelSchemaExtensionResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema\n extension has started replicating to all domain controllers, the task can no longer be\n canceled. A schema extension can be canceled during any of the following states;\n Initializing, CreatingSnapshot, and\n UpdatingSchema.

", "smithy.api#examples": [ { "title": "To cancel a Microsoft AD schema extension that is in progress", "documentation": "The following example cancels an in-progress schema extension to a Microsoft AD directory.", "input": { "DirectoryId": "d-92654abfed", "SchemaExtensionId": "e-926731d2a0" }, "output": {} } ] } }, "com.amazonaws.directoryservice#CancelSchemaExtensionRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory whose schema extension will be canceled.

", "smithy.api#required": {} } }, "SchemaExtensionId": { "target": "com.amazonaws.directoryservice#SchemaExtensionId", "traits": { "smithy.api#documentation": "

The identifier of the schema extension that will be canceled.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CancelSchemaExtensionResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#Certificate": { "type": "structure", "members": { "CertificateId": { "target": "com.amazonaws.directoryservice#CertificateId", "traits": { "smithy.api#documentation": "

The identifier of the certificate.

" } }, "State": { "target": "com.amazonaws.directoryservice#CertificateState", "traits": { "smithy.api#documentation": "

The state of the certificate.

" } }, "StateReason": { "target": "com.amazonaws.directoryservice#CertificateStateReason", "traits": { "smithy.api#documentation": "

Describes a state change for the certificate.

" } }, "CommonName": { "target": "com.amazonaws.directoryservice#CertificateCN", "traits": { "smithy.api#documentation": "

The common name for the certificate.

" } }, "RegisteredDateTime": { "target": "com.amazonaws.directoryservice#CertificateRegisteredDateTime", "traits": { "smithy.api#documentation": "

The date and time that the certificate was registered.

" } }, "ExpiryDateTime": { "target": "com.amazonaws.directoryservice#CertificateExpiryDateTime", "traits": { "smithy.api#documentation": "

The date and time when the certificate will expire.

" } }, "Type": { "target": "com.amazonaws.directoryservice#CertificateType", "traits": { "smithy.api#documentation": "

The function that the registered certificate performs. Valid values include\n ClientLDAPS or ClientCertAuth. The default value is\n ClientLDAPS.

" } }, "ClientCertAuthSettings": { "target": "com.amazonaws.directoryservice#ClientCertAuthSettings", "traits": { "smithy.api#documentation": "

A ClientCertAuthSettings object that contains client certificate\n authentication settings.

" } } }, "traits": { "smithy.api#documentation": "

Information about the certificate.

" } }, "com.amazonaws.directoryservice#CertificateAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The certificate has already been registered into the system.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#CertificateCN": { "type": "string" }, "com.amazonaws.directoryservice#CertificateData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 } } }, "com.amazonaws.directoryservice#CertificateDoesNotExistException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The certificate is not present in the system for describe or deregister activities.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#CertificateExpiryDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#CertificateId": { "type": "string", "traits": { "smithy.api#pattern": "^c-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#CertificateInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The certificate is being used for the LDAP security connection and cannot be removed\n without disabling LDAP security.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#CertificateInfo": { "type": "structure", "members": { "CertificateId": { "target": "com.amazonaws.directoryservice#CertificateId", "traits": { "smithy.api#documentation": "

The identifier of the certificate.

" } }, "CommonName": { "target": "com.amazonaws.directoryservice#CertificateCN", "traits": { "smithy.api#documentation": "

The common name for the certificate.

" } }, "State": { "target": "com.amazonaws.directoryservice#CertificateState", "traits": { "smithy.api#documentation": "

The state of the certificate.

" } }, "ExpiryDateTime": { "target": "com.amazonaws.directoryservice#CertificateExpiryDateTime", "traits": { "smithy.api#documentation": "

The date and time when the certificate will expire.

" } }, "Type": { "target": "com.amazonaws.directoryservice#CertificateType", "traits": { "smithy.api#documentation": "

The function that the registered certificate performs. Valid values include\n ClientLDAPS or ClientCertAuth. The default value is\n ClientLDAPS.

" } } }, "traits": { "smithy.api#documentation": "

Contains general information about a certificate.

" } }, "com.amazonaws.directoryservice#CertificateLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The certificate could not be added because the certificate limit has been reached.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#CertificateRegisteredDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#CertificateState": { "type": "enum", "members": { "REGISTERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Registering" } }, "REGISTERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Registered" } }, "REGISTER_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RegisterFailed" } }, "DEREGISTERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deregistering" } }, "DEREGISTERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deregistered" } }, "DEREGISTER_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeregisterFailed" } } } }, "com.amazonaws.directoryservice#CertificateStateReason": { "type": "string" }, "com.amazonaws.directoryservice#CertificateType": { "type": "enum", "members": { "CLIENT_CERT_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClientCertAuth" } }, "CLIENT_LDAPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClientLDAPS" } } } }, "com.amazonaws.directoryservice#CertificatesInfo": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#CertificateInfo" } }, "com.amazonaws.directoryservice#CidrIp": { "type": "string", "traits": { "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/([1-9]|[1-2][0-9]|3[0-2]))$" } }, "com.amazonaws.directoryservice#CidrIps": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#CidrIp" } }, "com.amazonaws.directoryservice#CidrIpv6": { "type": "string", "traits": { "smithy.api#pattern": "^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){1,7}:)|(([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2})|(([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3})|(([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4})|(([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5})|([0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))|(:((:[0-9a-fA-F]{1,4}){1,7}|:)))\\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$" } }, "com.amazonaws.directoryservice#CidrIpv6s": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#CidrIpv6" } }, "com.amazonaws.directoryservice#ClientAuthenticationSettingInfo": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { "smithy.api#documentation": "

The type of client authentication for the specified directory. If no type is specified, a\n list of all client authentication types that are supported for the directory is retrieved.\n

" } }, "Status": { "target": "com.amazonaws.directoryservice#ClientAuthenticationStatus", "traits": { "smithy.api#documentation": "

Whether the client authentication type is enabled or disabled for the specified\n directory.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the status of the client authentication type was last\n updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a client authentication method for a directory.

" } }, "com.amazonaws.directoryservice#ClientAuthenticationSettingsInfo": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#ClientAuthenticationSettingInfo" } }, "com.amazonaws.directoryservice#ClientAuthenticationStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.directoryservice#ClientAuthenticationType": { "type": "enum", "members": { "SMART_CARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SmartCard" } }, "SMART_CARD_OR_PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SmartCardOrPassword" } } } }, "com.amazonaws.directoryservice#ClientCertAuthSettings": { "type": "structure", "members": { "OCSPUrl": { "target": "com.amazonaws.directoryservice#OCSPUrl", "traits": { "smithy.api#documentation": "

Specifies the URL of the default OCSP server used to check for revocation status. A\n secondary value to any OCSP address found in the AIA extension of the user certificate.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the client certificate authentication settings for the\n RegisterCertificate and DescribeCertificate operations.

" } }, "com.amazonaws.directoryservice#ClientException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

A client exception has occurred.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#Computer": { "type": "structure", "members": { "ComputerId": { "target": "com.amazonaws.directoryservice#SID", "traits": { "smithy.api#documentation": "

The identifier of the computer.

" } }, "ComputerName": { "target": "com.amazonaws.directoryservice#ComputerName", "traits": { "smithy.api#documentation": "

The computer name.

" } }, "ComputerAttributes": { "target": "com.amazonaws.directoryservice#Attributes", "traits": { "smithy.api#documentation": "

An array of Attribute objects containing the LDAP attributes that belong to the\n computer account.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a computer account in a directory.

" } }, "com.amazonaws.directoryservice#ComputerName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 15 } } }, "com.amazonaws.directoryservice#ComputerPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 64 }, "smithy.api#pattern": "^[\\u0020-\\u00FF]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#ConditionalForwarder": { "type": "structure", "members": { "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domains pointed to by the\n conditional forwarder.

" } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName. This is the\n IP address of the DNS server that your conditional forwarder points to.

" } }, "DnsIpv6Addrs": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the remote DNS server associated with RemoteDomainName. This is the\n IPv6 address of the DNS server that your conditional forwarder points to.

" } }, "ReplicationScope": { "target": "com.amazonaws.directoryservice#ReplicationScope", "traits": { "smithy.api#documentation": "

The replication scope of the conditional forwarder. The only allowed value is\n Domain, which will replicate the conditional forwarder to all of the domain\n controllers for your Amazon Web Services directory.

" } } }, "traits": { "smithy.api#documentation": "

Points to a remote domain with which you are setting up a trust relationship.\n Conditional forwarders are required in order to set up a trust relationship with another\n domain.

" } }, "com.amazonaws.directoryservice#ConditionalForwarders": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#ConditionalForwarder" } }, "com.amazonaws.directoryservice#ConnectDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ConnectDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#ConnectDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryLimitExceededException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Creates an AD Connector to connect to a self-managed directory.

\n

Before you call ConnectDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

", "smithy.api#examples": [ { "title": "To connect to an on-premises directory", "documentation": "The following example creates an AD Connector to connect to an on-premises directory.", "input": { "Name": "corp.example.com", "ShortName": "corp", "Password": "Str0ngP@ssw0rd", "Description": "Connector to corp", "Size": "Small", "ConnectSettings": { "CustomerUserName": "Administrator", "VpcId": "vpc-45025421", "SubnetIds": [ "subnet-ba0146de", "subnet-bef46bc8" ], "CustomerDnsIps": [ "172.30.21.228" ] } }, "output": { "DirectoryId": "d-92654abfed" } } ] } }, "com.amazonaws.directoryservice#ConnectDirectoryRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified name of your self-managed directory, such as\n corp.example.com.

", "smithy.api#required": {} } }, "ShortName": { "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { "smithy.api#documentation": "

The NetBIOS name of your self-managed directory, such as CORP.

" } }, "Password": { "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { "smithy.api#documentation": "

The password for your self-managed user account.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

A description for the directory.

" } }, "Size": { "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { "smithy.api#documentation": "

The size of the directory.

", "smithy.api#required": {} } }, "ConnectSettings": { "target": "com.amazonaws.directoryservice#DirectoryConnectSettings", "traits": { "smithy.api#documentation": "

A DirectoryConnectSettings object that contains additional information\n for the operation.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

The tags to be assigned to AD Connector.

" } }, "NetworkType": { "target": "com.amazonaws.directoryservice#NetworkType", "traits": { "smithy.api#documentation": "

The network type for your directory. The default value is IPv4 or\n IPv6 based on the provided subnet capabilities.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the ConnectDirectory operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ConnectDirectoryResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the new directory.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the ConnectDirectory operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ConnectPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#ConnectedDirectoriesLimitReached": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#CreateAlias": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateAliasRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateAliasResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Creates an alias for a directory and assigns the alias to the directory. The alias is used\n to construct the access URL for the directory, such as\n http://.awsapps.com.

\n \n

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

\n
", "smithy.api#examples": [ { "title": "To create an alias for a directory", "documentation": "The following example creates an alias for a directory.", "input": { "DirectoryId": "d-92654abfed", "Alias": "salesorg" }, "output": { "DirectoryId": "d-92654abfed", "Alias": "salesorg" } } ] } }, "com.amazonaws.directoryservice#CreateAliasRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to create the alias.

", "smithy.api#required": {} } }, "Alias": { "target": "com.amazonaws.directoryservice#AliasName", "traits": { "smithy.api#documentation": "

The requested alias.

\n

The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an\n EntityAlreadyExistsException error if the alias already exists.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the CreateAlias operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateAliasResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

" } }, "Alias": { "target": "com.amazonaws.directoryservice#AliasName", "traits": { "smithy.api#documentation": "

The alias for the directory.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the CreateAlias operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateComputer": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateComputerRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateComputerResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AuthenticationFailedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Creates an Active Directory computer object in the specified directory.

", "smithy.api#examples": [ { "title": "To create a computer account", "documentation": "The following example creates a computer account in the specified directory, and joins the computer to the directory.", "input": { "DirectoryId": "d-92654abfed", "ComputerName": "labcomputer", "Password": "Str0ngP@ssw0rd", "OrganizationalUnitDistinguishedName": "OU=Computers,OU=example,DC=corp,DC=example,DC=com", "ComputerAttributes": [ { "Name": "ip", "Value": "192.168.101.100" } ] }, "output": { "Computer": { "ComputerAttributes": [ { "Name": "DistinguishedName", "Value": "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com" }, { "Name": "WindowsSamName", "Value": "labcomputer$" } ], "ComputerId": "S-1-5-21-1932691875-1648176379-1176097576-1124", "ComputerName": "labcomputer" } } } ] } }, "com.amazonaws.directoryservice#CreateComputerRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory in which to create the computer account.

", "smithy.api#required": {} } }, "ComputerName": { "target": "com.amazonaws.directoryservice#ComputerName", "traits": { "smithy.api#documentation": "

The name of the computer account.

", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.directoryservice#ComputerPassword", "traits": { "smithy.api#documentation": "

A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

", "smithy.api#required": {} } }, "OrganizationalUnitDistinguishedName": { "target": "com.amazonaws.directoryservice#OrganizationalUnitDN", "traits": { "smithy.api#documentation": "

The fully-qualified distinguished name of the organizational unit to place the computer account in.

" } }, "ComputerAttributes": { "target": "com.amazonaws.directoryservice#Attributes", "traits": { "smithy.api#documentation": "

An array of Attribute objects that contain any LDAP attributes to apply to the\n computer account.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the CreateComputer operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateComputerResult": { "type": "structure", "members": { "Computer": { "target": "com.amazonaws.directoryservice#Computer", "traits": { "smithy.api#documentation": "

A Computer object that represents the computer account.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results for the CreateComputer operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateConditionalForwarder": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateConditionalForwarderRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateConditionalForwarderResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional\n forwarders are required in order to set up a trust relationship with another domain. The\n conditional forwarder points to the trusted domain.

", "smithy.api#examples": [ { "title": "To create a conditional forwarder", "documentation": "The following example creates a conditional forwarder associated with your AWS directory.", "input": { "DirectoryId": "d-92654abfed", "RemoteDomainName": "sales.example.com", "DnsIpAddrs": [ "172.30.21.228" ] }, "output": {} } ] } }, "com.amazonaws.directoryservice#CreateConditionalForwarderRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory ID of the Amazon Web Services directory for which you are creating the conditional\n forwarder.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you will set up\n a trust relationship.

", "smithy.api#required": {} } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": [], "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName.

" } }, "DnsIpv6Addrs": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the remote DNS server associated with RemoteDomainName.

" } } }, "traits": { "smithy.api#documentation": "

Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active\n Directory. Conditional forwarders are required in order to set up a trust relationship with\n another domain.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateConditionalForwarderResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The result of a CreateConditinalForwarder request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryLimitExceededException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.

\n

Before you call CreateDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

", "smithy.api#examples": [ { "title": "To create a Simple AD directory", "documentation": "The following example creates a Simple AD directory.", "input": { "Name": "seattle.example.com", "ShortName": "seattle", "Password": "Str0ngP@ssw0rd", "Description": "Regional directory for example.com", "Size": "Small", "VpcSettings": { "SubnetIds": [ "subnet-ba0146de", "subnet-bef46bc8" ], "VpcId": "vpc-45025421" } }, "output": { "DirectoryId": "d-92654abfed" } } ] } }, "com.amazonaws.directoryservice#CreateDirectoryRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified name for the directory, such as corp.example.com.

", "smithy.api#required": {} } }, "ShortName": { "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { "smithy.api#documentation": "

The NetBIOS name of the directory, such as CORP.

" } }, "Password": { "target": "com.amazonaws.directoryservice#Password", "traits": { "smithy.api#documentation": "

The password for the directory administrator. The directory creation process creates a\n directory administrator account with the user name Administrator and this\n password.

\n

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

\n

The regex pattern for this string is made up of the following conditions:

\n \n

AND any 3 of the following password complexity rules required by Active Directory:

\n \n

For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

A description for the directory.

" } }, "Size": { "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { "smithy.api#documentation": "

The size of the directory.

", "smithy.api#required": {} } }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", "traits": { "smithy.api#documentation": "

A DirectoryVpcSettings object that contains additional information for\n the operation.

" } }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

The tags to be assigned to the Simple AD directory.

" } }, "NetworkType": { "target": "com.amazonaws.directoryservice#NetworkType", "traits": { "smithy.api#documentation": "

The network type for your directory. Simple AD supports IPv4 and Dual-stack only.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the CreateDirectory operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateDirectoryResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory that was created.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the CreateDirectory operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateHybridAD": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateHybridADRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateHybridADResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ADAssessmentLimitExceededException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryLimitExceededException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Creates a hybrid directory that connects your self-managed Active Directory (AD)\n infrastructure and Amazon Web Services.

\n

You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you\n use this operation.

\n

Updates are applied asynchronously. Use DescribeDirectories to\n monitor the progress of directory creation.

" } }, "com.amazonaws.directoryservice#CreateHybridADRequest": { "type": "structure", "members": { "SecretArn": { "target": "com.amazonaws.directoryservice#SecretArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials for the service account used to join hybrid domain controllers to your\n self-managed AD domain. This secret is used once and not stored.

\n

The secret must contain key-value pairs with keys matching\n customerAdAdminDomainUsername and\n customerAdAdminDomainPassword. For example:\n {\"customerAdAdminDomainUsername\":\"carlos_salazar\",\"customerAdAdminDomainPassword\":\"ExamplePassword123!\"}.

", "smithy.api#required": {} } }, "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The unique identifier of the successful directory assessment that validates your\n self-managed AD environment. You must have a successful directory assessment before you\n create a hybrid directory.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

The tags to be assigned to the directory. Each tag consists of a key and value pair.\n You can specify multiple tags as a list.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateHybridADResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The unique identifier of the newly created hybrid directory.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateLogSubscription": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateLogSubscriptionRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateLogSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InsufficientPermissionsException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Creates a subscription to forward real-time Directory Service domain controller security\n logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.

" } }, "com.amazonaws.directoryservice#CreateLogSubscriptionRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory to which you want to subscribe and receive real-time logs to\n your specified CloudWatch log group.

", "smithy.api#required": {} } }, "LogGroupName": { "target": "com.amazonaws.directoryservice#LogGroupName", "traits": { "smithy.api#documentation": "

The name of the CloudWatch log group where the real-time domain controller logs are\n forwarded.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateLogSubscriptionResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateMicrosoftAD": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateMicrosoftADRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateMicrosoftADResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryLimitExceededException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.

\n

Before you call CreateMicrosoftAD, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what permissions\n are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

", "smithy.api#examples": [ { "title": "To create a Microsoft AD directory", "documentation": "The following example creates a Microsoft AD directory in the AWS cloud.", "input": { "Name": "ad.example.com", "ShortName": "ad", "Password": "Str0ngP@ssw0rd", "Description": "Corporate AD directory", "VpcSettings": { "SubnetIds": [ "subnet-ba0146de", "subnet-bef46bc8" ], "VpcId": "vpc-45025421" } }, "output": { "DirectoryId": "d-92654abfed" } } ] } }, "com.amazonaws.directoryservice#CreateMicrosoftADRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified domain name for the Managed Microsoft AD directory, such as\n corp.example.com. This name will resolve inside your VPC only. It does not need\n to be publicly resolvable.

", "smithy.api#required": {} } }, "ShortName": { "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { "smithy.api#documentation": "

The NetBIOS name for your domain, such as CORP. If you don't specify a\n NetBIOS name, it will default to the first part of your directory DNS. For example,\n CORP for the directory DNS corp.example.com.

" } }, "Password": { "target": "com.amazonaws.directoryservice#Password", "traits": { "smithy.api#documentation": "

The password for the default administrative user named Admin.

\n

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

A description for the directory. This label will appear on the Amazon Web Services console\n Directory Details page after the directory is created.

" } }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", "traits": { "smithy.api#documentation": "

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

", "smithy.api#required": {} } }, "Edition": { "target": "com.amazonaws.directoryservice#DirectoryEdition", "traits": { "smithy.api#documentation": "

Managed Microsoft AD is available in two editions: Standard and\n Enterprise. Enterprise is the default.

" } }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

The tags to be assigned to the Managed Microsoft AD directory.

" } }, "NetworkType": { "target": "com.amazonaws.directoryservice#NetworkType", "traits": { "smithy.api#documentation": "

\n The network type for your domain. The default value is IPv4 or IPv6\n based on the provided subnet capabilities.

" } } }, "traits": { "smithy.api#documentation": "

Creates an Managed Microsoft AD directory.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateMicrosoftADResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory that was created.

" } } }, "traits": { "smithy.api#documentation": "

Result of a CreateMicrosoftAD request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateSnapshotRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateSnapshotResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#SnapshotLimitExceededException" } ], "traits": { "smithy.api#documentation": "

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

\n \n

You cannot take snapshots of AD Connector directories.

\n
", "smithy.api#examples": [ { "title": "To create a snapshot of a directory", "documentation": "The following example creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.", "input": { "DirectoryId": "d-92654abfed", "Name": "ad.example.com" }, "output": { "SnapshotId": "s-9267f8d3f0" } } ] } }, "com.amazonaws.directoryservice#CreateSnapshotBeforeSchemaExtension": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#CreateSnapshotBeforeUpdate": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#CreateSnapshotRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory of which to take a snapshot.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.directoryservice#SnapshotName", "traits": { "smithy.api#documentation": "

The descriptive name to apply to the snapshot.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the CreateSnapshot operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateSnapshotResult": { "type": "structure", "members": { "SnapshotId": { "target": "com.amazonaws.directoryservice#SnapshotId", "traits": { "smithy.api#documentation": "

The identifier of the snapshot that was created.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the CreateSnapshot operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreateTrust": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#CreateTrustRequest" }, "output": { "target": "com.amazonaws.directoryservice#CreateTrustResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For\n example, you can establish a trust between your Managed Microsoft AD directory, and your existing\n self-managed Microsoft Active Directory. This would allow you to provide users and groups\n access to resources in either domain, with a single set of credentials.

\n

This action initiates the creation of the Amazon Web Services side of a trust relationship between an\n Managed Microsoft AD directory and an external domain. You can create either a forest trust or an\n external trust.

", "smithy.api#examples": [ { "title": "To create a trust", "documentation": "The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.", "input": { "DirectoryId": "d-92654abfed", "RemoteDomainName": "europe.example.com", "TrustPassword": "Str0ngP@ssw0rd", "TrustDirection": "One-Way: Outgoing", "TrustType": "Forest", "ConditionalForwarderIpAddrs": [ "172.30.21.228" ] }, "output": { "TrustId": "t-9267353743" } } ] } }, "com.amazonaws.directoryservice#CreateTrustRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID of the Managed Microsoft AD directory for which to establish the trust\n relationship.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the\n trust relationship.

", "smithy.api#required": {} } }, "TrustPassword": { "target": "com.amazonaws.directoryservice#TrustPassword", "traits": { "smithy.api#documentation": "

The trust password. The trust password must be the same password that was used when creating the trust\n relationship on the external domain.

", "smithy.api#required": {} } }, "TrustDirection": { "target": "com.amazonaws.directoryservice#TrustDirection", "traits": { "smithy.api#documentation": "

The direction of the trust relationship.

", "smithy.api#required": {} } }, "TrustType": { "target": "com.amazonaws.directoryservice#TrustType", "traits": { "smithy.api#documentation": "

The trust relationship type. Forest is the default.

" } }, "ConditionalForwarderIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName.

" } }, "ConditionalForwarderIpv6Addrs": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the remote DNS server associated with RemoteDomainName.

" } }, "SelectiveAuth": { "target": "com.amazonaws.directoryservice#SelectiveAuth", "traits": { "smithy.api#documentation": "

Optional parameter to enable selective authentication for the trust.

" } } }, "traits": { "smithy.api#documentation": "

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For\n example, you can establish a trust between your Managed Microsoft AD directory, and your existing\n self-managed Microsoft Active Directory. This would allow you to provide users and groups\n access to resources in either domain, with a single set of credentials.

\n

This action initiates the creation of the Amazon Web Services side of a trust relationship between an\n Managed Microsoft AD directory and an external domain.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#CreateTrustResult": { "type": "structure", "members": { "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

A unique identifier for the trust relationship that was created.

" } } }, "traits": { "smithy.api#documentation": "

The result of a CreateTrust request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#CreatedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#CustomerDnsIps": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#IpAddr" }, "traits": { "smithy.api#length": { "min": 2, "max": 2 } } }, "com.amazonaws.directoryservice#CustomerId": { "type": "string", "traits": { "smithy.api#pattern": "^(\\d{12})$" } }, "com.amazonaws.directoryservice#CustomerUserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^(?!.*\\\\|.*\"|.*\\/|.*\\[|.*\\]|.*:|.*;|.*\\||.*=|.*,|.*\\+|.*\\*|.*\\?|.*<|.*>|.*@).*$" } }, "com.amazonaws.directoryservice#DataAccessStatus": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabling" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabling" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.directoryservice#DeleteADAssessment": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeleteADAssessmentRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeleteADAssessmentResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deletes a directory assessment and all associated data. This operation permanently\n removes the assessment results, validation reports, and configuration\n information.

\n

You cannot delete system-initiated assessments. You can delete customer-created\n assessments even if they are in progress.

" } }, "com.amazonaws.directoryservice#DeleteADAssessmentRequest": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The unique identifier of the directory assessment to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeleteADAssessmentResult": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The unique identifier of the deleted directory assessment.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeleteAssociatedConditionalForwarder": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#DeleteConditionalForwarder": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeleteConditionalForwarderRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeleteConditionalForwarderResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deletes a conditional forwarder that has been set up for your Amazon Web Services\n directory.

", "smithy.api#examples": [ { "title": "To delete a conditional forwarder", "documentation": "The following example deletes a conditional forwarder. ", "input": { "DirectoryId": "d-92654abfed", "RemoteDomainName": "sales.example.com" }, "output": {} } ] } }, "com.amazonaws.directoryservice#DeleteConditionalForwarderRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory ID for which you are deleting the conditional forwarder.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you are deleting\n the conditional forwarder.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Deletes a conditional forwarder.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeleteConditionalForwarderResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The result of a DeleteConditionalForwarder request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeleteDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeleteDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeleteDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Deletes an Directory Service directory.

\n

Before you call DeleteDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

", "smithy.api#examples": [ { "title": "To delete a directory", "documentation": "The following example deletes a directory from your AWS account.", "input": { "DirectoryId": "d-92654abfed" }, "output": { "DirectoryId": "d-92654abfed" } } ] } }, "com.amazonaws.directoryservice#DeleteDirectoryRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DeleteDirectory operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeleteDirectoryResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory identifier.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the DeleteDirectory operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeleteLogSubscription": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeleteLogSubscriptionRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeleteLogSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified log subscription.

" } }, "com.amazonaws.directoryservice#DeleteLogSubscriptionRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory whose log subscription you want to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeleteLogSubscriptionResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeleteSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeleteSnapshotRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeleteSnapshotResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Deletes a directory snapshot.

", "smithy.api#examples": [ { "title": "To delete a snapshot", "documentation": "The following example deletes a directory snapshot.", "input": { "SnapshotId": "s-9267f8d3f0" }, "output": { "SnapshotId": "s-9267f8d3f0" } } ] } }, "com.amazonaws.directoryservice#DeleteSnapshotRequest": { "type": "structure", "members": { "SnapshotId": { "target": "com.amazonaws.directoryservice#SnapshotId", "traits": { "smithy.api#documentation": "

The identifier of the directory snapshot to be deleted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DeleteSnapshot operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeleteSnapshotResult": { "type": "structure", "members": { "SnapshotId": { "target": "com.amazonaws.directoryservice#SnapshotId", "traits": { "smithy.api#documentation": "

The identifier of the directory snapshot that was deleted.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the DeleteSnapshot operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeleteTrust": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeleteTrustRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeleteTrustResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external\n domain.

", "smithy.api#examples": [ { "title": "To delete a trust", "documentation": "The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.", "input": { "TrustId": "t-9267353743", "DeleteAssociatedConditionalForwarder": true }, "output": { "TrustId": "t-9267353743" } } ] } }, "com.amazonaws.directoryservice#DeleteTrustRequest": { "type": "structure", "members": { "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

The Trust ID of the trust relationship to be deleted.

", "smithy.api#required": {} } }, "DeleteAssociatedConditionalForwarder": { "target": "com.amazonaws.directoryservice#DeleteAssociatedConditionalForwarder", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Delete a conditional forwarder as part of a DeleteTrustRequest.

" } } }, "traits": { "smithy.api#documentation": "

Deletes the local side of an existing trust relationship between the Managed Microsoft AD\n directory and the external domain.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeleteTrustResult": { "type": "structure", "members": { "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

The Trust ID of the trust relationship that was deleted.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DeleteTrust request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeregisterCertificate": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeregisterCertificateRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeregisterCertificateResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#CertificateDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#CertificateInUseException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deletes from the system the certificate that was registered for secure LDAP or client\n certificate authentication.

" } }, "com.amazonaws.directoryservice#DeregisterCertificateRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "CertificateId": { "target": "com.amazonaws.directoryservice#CertificateId", "traits": { "smithy.api#documentation": "

The identifier of the certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeregisterCertificateResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DeregisterEventTopic": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DeregisterEventTopicRequest" }, "output": { "target": "com.amazonaws.directoryservice#DeregisterEventTopicResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified Amazon SNS topic.

", "smithy.api#examples": [ { "title": "To remove an event topic", "documentation": "The following example removes the specified directory as a publisher to the specified SNS topic.", "input": { "DirectoryId": "d-92654abfed", "TopicName": "snstopicexample" }, "output": {} } ] } }, "com.amazonaws.directoryservice#DeregisterEventTopicRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID to remove as a publisher. This directory will no longer send messages\n to the specified Amazon SNS topic.

", "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.directoryservice#TopicName", "traits": { "smithy.api#documentation": "

The name of the Amazon SNS topic from which to remove the directory as a\n publisher.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified Amazon SNS topic.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DeregisterEventTopicResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The result of a DeregisterEventTopic request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeADAssessment": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeADAssessmentRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeADAssessmentResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Retrieves detailed information about a directory assessment, including its current\n status, validation results, and configuration details. Use this operation to monitor\n assessment progress and review results.

" } }, "com.amazonaws.directoryservice#DescribeADAssessmentRequest": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The identifier of the directory assessment to describe.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeADAssessmentResult": { "type": "structure", "members": { "Assessment": { "target": "com.amazonaws.directoryservice#Assessment", "traits": { "smithy.api#documentation": "

Detailed information about the self-managed instance settings (IDs and DNS\n IPs).

" } }, "AssessmentReports": { "target": "com.amazonaws.directoryservice#AssessmentReports", "traits": { "smithy.api#documentation": "

A list of assessment reports containing validation results for each domain controller\n and test category. Each report includes specific validation details and outcomes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicy": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Retrieves detailed information about the certificate authority (CA) enrollment policy for\n the specified directory. This policy determines how client certificates are automatically enrolled and\n managed through Amazon Web Services Private Certificate Authority.

" } }, "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to retrieve the CA enrollment policy\n information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DescribeCAEnrollmentPolicy operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory associated with this CA enrollment policy.

" } }, "PcaConnectorArn": { "target": "com.amazonaws.directoryservice#PcaConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority (PCA) connector\n that is configured for automatic certificate enrollment in this directory.

" } }, "CaEnrollmentPolicyStatus": { "target": "com.amazonaws.directoryservice#CaEnrollmentPolicyStatus", "traits": { "smithy.api#documentation": "

The current status of the CA enrollment policy. This indicates if automatic certificate\n enrollment is currently active, inactive, or in a transitional state.

\n

Valid values:

\n " } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the CA enrollment policy was last modified or updated.

" } }, "CaEnrollmentPolicyStatusReason": { "target": "com.amazonaws.directoryservice#CaEnrollmentPolicyStatusReason", "traits": { "smithy.api#documentation": "

Additional information explaining the current status of the CA enrollment policy,\n particularly useful when the policy is in an error or transitional state.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the DescribeCAEnrollmentPolicy operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeCertificate": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeCertificateRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeCertificateResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#CertificateDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Displays information about the certificate registered for secure LDAP or client\n certificate authentication.

" } }, "com.amazonaws.directoryservice#DescribeCertificateRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "CertificateId": { "target": "com.amazonaws.directoryservice#CertificateId", "traits": { "smithy.api#documentation": "

The identifier of the certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeCertificateResult": { "type": "structure", "members": { "Certificate": { "target": "com.amazonaws.directoryservice#Certificate", "traits": { "smithy.api#documentation": "

Information about the certificate, including registered date time, certificate state, the\n reason for the state, expiration date time, and certificate common name.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeClientAuthenticationSettings": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about the type of client authentication for the specified directory,\n if the type is specified. If no type is specified, information about all client authentication\n types that are supported for the specified directory is retrieved. Currently, only\n SmartCard is supported.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ClientAuthenticationSettingsInfo", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to retrieve information.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { "smithy.api#documentation": "

The type of client authentication for which to retrieve information. If no type is\n specified, a list of all client authentication types that are supported for the specified\n directory is retrieved.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeClientAuthenticationSettingsResult.NextToken value from a\n previous call to DescribeClientAuthenticationSettings. Pass null if this is\n the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#PageLimit", "traits": { "smithy.api#documentation": "

The maximum number of items to return. If this value is zero, the maximum number of items\n is specified by the limitations of the operation.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsResult": { "type": "structure", "members": { "ClientAuthenticationSettingsInfo": { "target": "com.amazonaws.directoryservice#ClientAuthenticationSettingsInfo", "traits": { "smithy.api#documentation": "

Information about the type of client authentication for the specified directory. The\n following information is retrieved: The date and time when the status of the client\n authentication type was last updated, whether the client authentication type is enabled or\n disabled, and the type of client authentication.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The next token used to retrieve the client authentication settings if the number of\n setting types exceeds page limit and there is another page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeConditionalForwarders": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeConditionalForwardersRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeConditionalForwardersResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Obtains information about the conditional forwarders for this account.

\n

If no input parameters are provided for RemoteDomainNames, this request describes all\n conditional forwarders for the specified directory ID.

", "smithy.api#examples": [ { "title": "To describe conditional forwarders", "documentation": "The following example obtains information about the conditional forwarders for a specified directory.", "input": { "DirectoryId": "d-92654abfed", "RemoteDomainNames": [ "sales.example.com" ] }, "output": { "ConditionalForwarders": [] } } ] } }, "com.amazonaws.directoryservice#DescribeConditionalForwardersRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory ID for which to get the list of associated conditional\n forwarders.

", "smithy.api#required": {} } }, "RemoteDomainNames": { "target": "com.amazonaws.directoryservice#RemoteDomainNames", "traits": { "smithy.api#documentation": "

The fully qualified domain names (FQDN) of the remote domains for which to get the list\n of associated conditional forwarders. If this member is null, all conditional forwarders are\n returned.

" } } }, "traits": { "smithy.api#documentation": "

Describes a conditional forwarder.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeConditionalForwardersResult": { "type": "structure", "members": { "ConditionalForwarders": { "target": "com.amazonaws.directoryservice#ConditionalForwarders", "traits": { "smithy.api#documentation": "

The list of conditional forwarders that have been created.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeConditionalForwarder request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeDirectories": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeDirectoriesRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeDirectoriesResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Obtains information about the directories that belong to this account.

\n

You can retrieve information about specific directories by passing the directory\n identifiers in the DirectoryIds parameter. Otherwise, all directories that belong\n to the current account are returned.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n DescribeDirectoriesResult.NextToken member contains a token that you pass in\n the next call to DescribeDirectories to retrieve the next set of\n items.

\n

You can also specify a maximum number of return results with the Limit\n parameter.

", "smithy.api#examples": [ { "title": "To describe one or more directories", "documentation": "The following example obtains information about a specified directory.", "input": { "DirectoryIds": [ "d-92654abfed" ], "Limit": 0 }, "output": { "DirectoryDescriptions": [ { "AccessUrl": "myaccess.awsapps.com", "Alias": "myaccess", "DirectoryId": "d-92654abfed", "DnsIpAddrs": [ "172.30.21.228", "172.30.9.82" ], "LaunchTime": 1469737584.772, "Name": "corp.example.com", "ShortName": "example", "SsoEnabled": true, "Stage": "Active", "StageLastUpdatedDateTime": 1469739131.71, "Type": "MicrosoftAD", "VpcSettings": { "AvailabilityZones": [ "us-west-2a", "us-west-2b" ], "SubnetIds": [ "subnet-ba0146de", "subnet-bef46bc8" ], "VpcId": "vpc-45025421" } } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DirectoryDescriptions", "pageSize": "Limit" }, "smithy.test#smokeTests": [ { "id": "DescribeDirectoriesSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.directoryservice#DescribeDirectoriesRequest": { "type": "structure", "members": { "DirectoryIds": { "target": "com.amazonaws.directoryservice#DirectoryIds", "traits": { "smithy.api#documentation": "

A list of identifiers of the directories for which to obtain the information. If this\n member is null, all directories that belong to the current account are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of items to return. If this value is zero, the maximum number of items\n is specified by the limitations of the operation.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DescribeDirectories operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeDirectoriesResult": { "type": "structure", "members": { "DirectoryDescriptions": { "target": "com.amazonaws.directoryservice#DirectoryDescriptions", "traits": { "smithy.api#documentation": "

The list of available DirectoryDescription objects that were\n retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter in a subsequent call to DescribeDirectories to retrieve the next\n set of items.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the DescribeDirectories operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeDirectoryDataAccess": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeDirectoryDataAccessRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeDirectoryDataAccessResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Obtains status of directory data access enablement through the Directory Service Data API for the\n specified directory.

" } }, "com.amazonaws.directoryservice#DescribeDirectoryDataAccessRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeDirectoryDataAccessResult": { "type": "structure", "members": { "DataAccessStatus": { "target": "com.amazonaws.directoryservice#DataAccessStatus", "traits": { "smithy.api#documentation": "

The current status of data access through the Directory Service Data API.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeDomainControllers": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeDomainControllersRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeDomainControllersResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Provides information about any domain controllers in your directory.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#DescribeDomainControllersRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory for which to retrieve the domain controller\n information.

", "smithy.api#required": {} } }, "DomainControllerIds": { "target": "com.amazonaws.directoryservice#DomainControllerIds", "traits": { "smithy.api#documentation": "

A list of identifiers for the domain controllers whose information will be\n provided.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeDomainControllers.NextToken value from a previous call\n to DescribeDomainControllers. Pass null if this is the first call.\n

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of items to return.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeDomainControllersResult": { "type": "structure", "members": { "DomainControllers": { "target": "com.amazonaws.directoryservice#DomainControllers", "traits": { "smithy.api#documentation": "

List of the DomainController objects that were retrieved.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter in a subsequent call to DescribeDomainControllers retrieve the\n next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeEventTopics": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeEventTopicsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeEventTopicsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Obtains information about which Amazon SNS topics receive status messages from the specified\n directory.

\n

If no input parameters are provided, such as DirectoryId or TopicName, this request\n describes all of the associations in the account.

", "smithy.api#examples": [ { "title": "To describe event topics", "documentation": "The following example obtains information about which SNS topics receive status messages from the specified directory.", "input": { "DirectoryId": "d-92654abfed", "TopicNames": [ "snstopicexample" ] }, "output": { "EventTopics": [ { "DirectoryId": "d-92654abfed", "Status": "Registered", "TopicArn": "arn:aws:sns:us-east-2:123456789012:snstopicexample", "TopicName": "snstopicexample" } ] } } ] } }, "com.amazonaws.directoryservice#DescribeEventTopicsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID for which to get the list of associated Amazon SNS topics. If this member\n is null, associations for all Directory IDs are returned.

" } }, "TopicNames": { "target": "com.amazonaws.directoryservice#TopicNames", "traits": { "smithy.api#documentation": "

A list of Amazon SNS topic names for which to obtain the information. If this member is\n null, all associations for the specified Directory ID are returned.

\n

An empty list results in an InvalidParameterException being\n thrown.

" } } }, "traits": { "smithy.api#documentation": "

Describes event topics.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeEventTopicsResult": { "type": "structure", "members": { "EventTopics": { "target": "com.amazonaws.directoryservice#EventTopics", "traits": { "smithy.api#documentation": "

A list of Amazon SNS topic names that receive status messages from the specified Directory\n ID.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeEventTopic request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeHybridADUpdate": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeHybridADUpdateRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeHybridADUpdateResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about update activities for a hybrid directory. This operation\n provides details about configuration changes, administrator account updates, and\n self-managed instance settings (IDs and DNS IPs).

", "smithy.waiters#waitable": { "HybridADUpdated": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "UpdateActivities.SelfManagedInstances[].Status", "expected": "Updated", "comparator": "allStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "UpdateActivities.SelfManagedInstances[].Status", "expected": "UpdateFailed", "comparator": "anyStringEquals" } } } ], "minDelay": 120 } } } }, "com.amazonaws.directoryservice#DescribeHybridADUpdateRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the hybrid directory for which to retrieve update\n information.

", "smithy.api#required": {} } }, "UpdateType": { "target": "com.amazonaws.directoryservice#HybridUpdateType", "traits": { "smithy.api#documentation": "

The type of update activities to retrieve. Valid values include\n SelfManagedInstances and\n HybridAdministratorAccount.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The pagination token from a previous request to DescribeHybridADUpdate. Pass null if this is the first request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeHybridADUpdateResult": { "type": "structure", "members": { "UpdateActivities": { "target": "com.amazonaws.directoryservice#HybridUpdateActivities", "traits": { "smithy.api#documentation": "

Information about update activities for the hybrid directory, organized by update\n type.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent request to retrieve the next set of\n items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeLDAPSSettings": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeLDAPSSettingsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeLDAPSSettingsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Describes the status of LDAP security for the specified directory.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "LDAPSSettingsInfo", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#DescribeLDAPSSettingsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#LDAPSType", "traits": { "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is\n supported.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The type of next token used for pagination.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#PageLimit", "traits": { "smithy.api#documentation": "

Specifies the number of items that should be displayed on one page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeLDAPSSettingsResult": { "type": "structure", "members": { "LDAPSSettingsInfo": { "target": "com.amazonaws.directoryservice#LDAPSSettingsInfo", "traits": { "smithy.api#documentation": "

Information about LDAP security for the specified directory, including status of\n enablement, state last updated date time, and the reason for the state.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The next token used to retrieve the LDAPS settings if the number of setting types exceeds\n page limit and there is another page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeRegions": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeRegionsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeRegionsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Provides information about the Regions that are configured for multi-Region\n replication.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RegionsDescription" } } }, "com.amazonaws.directoryservice#DescribeRegionsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { "smithy.api#documentation": "

The name of the Region. For example, us-east-1.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeRegionsResult": { "type": "structure", "members": { "RegionsDescription": { "target": "com.amazonaws.directoryservice#RegionsDescription", "traits": { "smithy.api#documentation": "

List of Region information related to the directory for each replicated Region.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter in a subsequent call to DescribeRegions to retrieve the next set\n of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeSettings": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeSettingsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeSettingsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about the configurable settings for the specified directory.

" } }, "com.amazonaws.directoryservice#DescribeSettingsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to retrieve information.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationStatus", "traits": { "smithy.api#documentation": "

The status of the directory settings for which to retrieve information.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeSettingsResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

" } }, "SettingEntries": { "target": "com.amazonaws.directoryservice#SettingEntries", "traits": { "smithy.api#documentation": "

The list of SettingEntry objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, token that indicates that more results are available. Pass this value for the\n NextToken parameter in a subsequent call to DescribeSettings to\n retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeSharedDirectories": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeSharedDirectoriesRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeSharedDirectoriesResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Returns the shared directories in your account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "SharedDirectories", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#DescribeSharedDirectoriesRequest": { "type": "structure", "members": { "OwnerDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Returns the identifier of the directory in the directory owner account.

", "smithy.api#required": {} } }, "SharedDirectoryIds": { "target": "com.amazonaws.directoryservice#DirectoryIds", "traits": { "smithy.api#documentation": "

A list of identifiers of all shared directories in your account.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeSharedDirectoriesResult.NextToken value from a previous call to\n DescribeSharedDirectories. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The number of shared directories to return in the response object.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeSharedDirectoriesResult": { "type": "structure", "members": { "SharedDirectories": { "target": "com.amazonaws.directoryservice#SharedDirectories", "traits": { "smithy.api#documentation": "

A list of all shared directories in your account.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, token that indicates that more results are available. Pass this value for the\n NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeSnapshotsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeSnapshotsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Obtains information about the directory snapshots that belong to this account.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the DescribeSnapshots.NextToken\n member contains a token that you pass in the next call to DescribeSnapshots to\n retrieve the next set of items.

\n

You can also specify a maximum number of return results with the Limit\n parameter.

", "smithy.api#examples": [ { "title": "To describe snapshots", "documentation": "The following example obtains information about a specified directory snapshot.", "input": { "DirectoryId": "d-92654abfed", "SnapshotIds": [ "s-9267f6da4e" ], "Limit": 0 }, "output": { "Snapshots": [ { "DirectoryId": "d-92673c8a8f", "SnapshotId": "s-9267f6da4e", "StartTime": 1481289211.615, "Status": "Completed", "Type": "Auto" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Snapshots", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#DescribeSnapshotsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to retrieve snapshot information.

" } }, "SnapshotIds": { "target": "com.amazonaws.directoryservice#SnapshotIds", "traits": { "smithy.api#documentation": "

A list of identifiers of the snapshots to obtain the information for. If this member is\n null or empty, all snapshots are returned using the Limit and NextToken\n members.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeSnapshotsResult.NextToken value from a previous call to\n DescribeSnapshots. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of objects to return.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DescribeSnapshots operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeSnapshotsResult": { "type": "structure", "members": { "Snapshots": { "target": "com.amazonaws.directoryservice#Snapshots", "traits": { "smithy.api#documentation": "

The list of Snapshot objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value in the NextToken member of\n a subsequent call to DescribeSnapshots.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the DescribeSnapshots operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeTrusts": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeTrustsRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeTrustsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Obtains information about the trust relationships for this account.

\n

If no input parameters are provided, such as DirectoryId or TrustIds, this request\n describes all the trust relationships belonging to the account.

", "smithy.api#examples": [ { "title": "To describe a trust ", "documentation": "The following example obtains information about the trust relationship for a specified directory.", "input": { "DirectoryId": "d-92654abfed", "TrustIds": [ "t-9267353df0" ], "Limit": 0 }, "output": { "Trusts": [ { "CreatedDateTime": 1481749250.657, "DirectoryId": "d-92654abfed", "LastUpdatedDateTime": 1481749260.156, "RemoteDomainName": "sales.example.com", "StateLastUpdatedDateTime": 1481749260.156, "TrustDirection": "One-Way: Outgoing", "TrustId": "t-9267353df0", "TrustState": "Failed", "TrustStateReason": "The specified domain either does not exist or could not be contacted. Name: sales.example.com", "TrustType": "Forest" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Trusts", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#DescribeTrustsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID of the Amazon Web Services directory that is a part of the requested trust\n relationship.

" } }, "TrustIds": { "target": "com.amazonaws.directoryservice#TrustIds", "traits": { "smithy.api#documentation": "

A list of identifiers of the trust relationships for which to obtain the information. If\n this member is null, all trust relationships that belong to the current account are\n returned.

\n

An empty list results in an InvalidParameterException being thrown.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeTrustsResult.NextToken value from a previous call to\n DescribeTrusts. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of objects to return.

" } } }, "traits": { "smithy.api#documentation": "

Describes the trust relationships for a particular Managed Microsoft AD directory. If no input\n parameters are provided, such as directory ID or trust ID, this request describes all the\n trust relationships.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeTrustsResult": { "type": "structure", "members": { "Trusts": { "target": "com.amazonaws.directoryservice#Trusts", "traits": { "smithy.api#documentation": "

The list of Trust objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the\n requested number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.

" } } }, "traits": { "smithy.api#documentation": "

The result of a DescribeTrust request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DescribeUpdateDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DescribeUpdateDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#DescribeUpdateDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Describes the updates of a directory for a particular update type.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "UpdateActivities" } } }, "com.amazonaws.directoryservice#DescribeUpdateDirectoryRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The unique identifier of the directory.

", "smithy.api#required": {} } }, "UpdateType": { "target": "com.amazonaws.directoryservice#UpdateType", "traits": { "smithy.api#documentation": "

The type of updates you want to describe for the directory.

", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { "smithy.api#documentation": "

The name of the Region.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeUpdateDirectoryResult. NextToken value from a previous call to\n DescribeUpdateDirectory. Pass null if this is the first call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DescribeUpdateDirectoryResult": { "type": "structure", "members": { "UpdateActivities": { "target": "com.amazonaws.directoryservice#UpdateActivities", "traits": { "smithy.api#documentation": "

The list of update activities on a directory for the requested update type.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#Description": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" } }, "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers": { "type": "integer", "traits": { "smithy.api#range": { "min": 2 } } }, "com.amazonaws.directoryservice#DirectoryAlreadyInRegionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The Region you specified is the same Region where the Managed Microsoft AD directory was created.\n Specify a different Region and try again.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryAlreadySharedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified directory has already been shared with this Amazon Web Services account.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingAllowedValues": { "type": "string" }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingDataType": { "type": "string" }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastRequestedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastUpdatedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9-/. _]*$" } }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestDetailedStatus": { "type": "map", "key": { "target": "com.amazonaws.directoryservice#RegionName" }, "value": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationStatus" } }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestStatusMessage": { "type": "string" }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingType": { "type": "string" }, "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9_]*$" } }, "com.amazonaws.directoryservice#DirectoryConfigurationStatus": { "type": "enum", "members": { "REQUESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Requested" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updating" } }, "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updated" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Default" } } } }, "com.amazonaws.directoryservice#DirectoryConnectSettings": { "type": "structure", "members": { "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC in which the AD Connector is created.

", "smithy.api#required": {} } }, "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { "smithy.api#documentation": "

A list of subnet identifiers in the VPC in which the AD Connector is created.

", "smithy.api#required": {} } }, "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": [], "smithy.api#documentation": "

The IP addresses of DNS servers or domain controllers in your\n self-managed directory.

" } }, "CustomerDnsIpsV6": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

The IPv6 addresses of DNS servers or domain controllers in your\n self-managed directory.

" } }, "CustomerUserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { "smithy.api#documentation": "

The user name of an account in your self-managed directory that is used to connect to the\n directory. This account must have the following permissions:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains connection settings for creating an AD\n Connector with the ConnectDirectory action.

" } }, "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription": { "type": "structure", "members": { "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC that the AD Connector is in.

" } }, "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { "smithy.api#documentation": "

A list of subnet identifiers in the VPC that the AD Connector is in.

" } }, "CustomerUserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { "smithy.api#documentation": "

The user name of the service account in your self-managed directory.

" } }, "SecurityGroupId": { "target": "com.amazonaws.directoryservice#SecurityGroupId", "traits": { "smithy.api#documentation": "

The security group identifier for the AD Connector directory.

" } }, "AvailabilityZones": { "target": "com.amazonaws.directoryservice#AvailabilityZones", "traits": { "smithy.api#documentation": "

The Availability Zones that the directory is in.

" } }, "ConnectIps": { "target": "com.amazonaws.directoryservice#IpAddrs", "traits": { "smithy.api#documentation": "

The IP addresses of the AD Connector servers.

" } }, "ConnectIpsV6": { "target": "com.amazonaws.directoryservice#IpV6Addrs", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the AD Connector servers.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about an AD Connector directory.

" } }, "com.amazonaws.directoryservice#DirectoryDescription": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory identifier.

" } }, "Name": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { "smithy.api#documentation": "

The fully qualified name of the directory.

" } }, "ShortName": { "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { "smithy.api#documentation": "

The short name of the directory.

" } }, "Size": { "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { "smithy.api#documentation": "

The directory size.

" } }, "Edition": { "target": "com.amazonaws.directoryservice#DirectoryEdition", "traits": { "smithy.api#documentation": "

The edition associated with this directory.

" } }, "Alias": { "target": "com.amazonaws.directoryservice#AliasName", "traits": { "smithy.api#documentation": "

The alias for the directory. If no alias exists, the alias is the directory identifier,\n such as d-XXXXXXXXXX.

" } }, "AccessUrl": { "target": "com.amazonaws.directoryservice#AccessUrl", "traits": { "smithy.api#documentation": "

The access URL for the directory, such as\n http://.awsapps.com. If no alias exists,\n is the directory identifier, such as\n d-XXXXXXXXXX.

" } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

The description for the directory.

" } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers.\n For an AD Connector directory, these are the IP addresses of self-managed directory to which\n the AD Connector is connected.

" } }, "DnsIpv6Addrs": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IPv6 addresses of the Simple AD or Microsoft AD directory servers.\n For an AD Connector directory, these are the IPv6 addresses of the DNS servers or domain\n controllers in your self-managed directory to which the AD Connector is connected.

" } }, "Stage": { "target": "com.amazonaws.directoryservice#DirectoryStage", "traits": { "smithy.api#documentation": "

The current stage of the directory.

" } }, "ShareStatus": { "target": "com.amazonaws.directoryservice#ShareStatus", "traits": { "smithy.api#documentation": "

Current directory status of the shared Managed Microsoft AD directory.

" } }, "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account\n by sending a shared directory request (HANDSHAKE).

" } }, "ShareNotes": { "target": "com.amazonaws.directoryservice#Notes", "traits": { "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" } }, "LaunchTime": { "target": "com.amazonaws.directoryservice#LaunchTime", "traits": { "smithy.api#documentation": "

The date and time when the directory was created.

" } }, "StageLastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the stage was last updated.

" } }, "Type": { "target": "com.amazonaws.directoryservice#DirectoryType", "traits": { "smithy.api#documentation": "

The directory type.

" } }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", "traits": { "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. Present only for Simple AD and Managed Microsoft AD\n directories.

" } }, "ConnectSettings": { "target": "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription", "traits": { "smithy.api#documentation": "

\n DirectoryConnectSettingsDescription object that contains additional\n information about an AD Connector directory. Present only for AD Connector\n directories.

" } }, "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { "smithy.api#documentation": "

Information about the RadiusSettings object configured for this\n directory.

" } }, "RadiusStatus": { "target": "com.amazonaws.directoryservice#RadiusStatus", "traits": { "smithy.api#documentation": "

The status of the RADIUS MFA server connection.

" } }, "StageReason": { "target": "com.amazonaws.directoryservice#StageReason", "traits": { "smithy.api#documentation": "

Additional information about the directory stage.

" } }, "SsoEnabled": { "target": "com.amazonaws.directoryservice#SsoEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether single sign-on is enabled for the directory. For more information, see\n EnableSso and DisableSso.

" } }, "DesiredNumberOfDomainControllers": { "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", "traits": { "smithy.api#documentation": "

The desired number of domain controllers in the directory if the directory is Microsoft\n AD.

" } }, "OwnerDirectoryDescription": { "target": "com.amazonaws.directoryservice#OwnerDirectoryDescription", "traits": { "smithy.api#documentation": "

Describes the Managed Microsoft AD directory in the directory owner account.

" } }, "RegionsInfo": { "target": "com.amazonaws.directoryservice#RegionsInfo", "traits": { "smithy.api#documentation": "

Lists the Regions where the directory has replicated.

" } }, "OsVersion": { "target": "com.amazonaws.directoryservice#OSVersion", "traits": { "smithy.api#documentation": "

The operating system (OS) version of the directory.

" } }, "HybridSettings": { "target": "com.amazonaws.directoryservice#HybridSettingsDescription", "traits": { "smithy.api#documentation": "

Contains information about the hybrid directory configuration for the directory,\n including Amazon Web Services System Manager managed node identifiers and DNS IPs.

" } }, "NetworkType": { "target": "com.amazonaws.directoryservice#NetworkType", "traits": { "smithy.api#documentation": "

The network type of the directory.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about an Directory Service directory.

" } }, "com.amazonaws.directoryservice#DirectoryDescriptions": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#DirectoryDescription" }, "traits": { "smithy.api#documentation": "

A list of directory descriptions.

" } }, "com.amazonaws.directoryservice#DirectoryDoesNotExistException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified directory does not exist in the system.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryEdition": { "type": "enum", "members": { "ENTERPRISE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enterprise" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Standard" } }, "HYBRID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Hybrid" } } } }, "com.amazonaws.directoryservice#DirectoryId": { "type": "string", "traits": { "smithy.api#pattern": "^d-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#DirectoryIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#DirectoryId" }, "traits": { "smithy.api#documentation": "

A list of directory identifiers.

" } }, "com.amazonaws.directoryservice#DirectoryInDesiredStateException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The directory is already updated to desired update type settings.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The maximum number of directories in the region has been reached. You can use the\n GetDirectoryLimits operation to determine your directory limits in\n the region.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryLimits": { "type": "structure", "members": { "CloudOnlyDirectoriesLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of cloud directories allowed in the Region.

" } }, "CloudOnlyDirectoriesCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The current number of cloud directories in the Region.

" } }, "CloudOnlyDirectoriesLimitReached": { "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates if the cloud directory limit has been reached.

" } }, "CloudOnlyMicrosoftADLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of Managed Microsoft AD directories allowed in the region.

" } }, "CloudOnlyMicrosoftADCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The current number of Managed Microsoft AD directories in the region.

" } }, "CloudOnlyMicrosoftADLimitReached": { "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates if the Managed Microsoft AD directory limit has been reached.

" } }, "ConnectedDirectoriesLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of connected directories allowed in the Region.

" } }, "ConnectedDirectoriesCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The current number of connected directories in the Region.

" } }, "ConnectedDirectoriesLimitReached": { "target": "com.amazonaws.directoryservice#ConnectedDirectoriesLimitReached", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates if the connected directory limit has been reached.

" } } }, "traits": { "smithy.api#documentation": "

Contains directory limit information for a Region.

" } }, "com.amazonaws.directoryservice#DirectoryName": { "type": "string", "traits": { "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" } }, "com.amazonaws.directoryservice#DirectoryNotSharedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified directory has not been shared with this Amazon Web Services account.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryService_20150416": { "type": "service", "version": "2015-04-16", "operations": [ { "target": "com.amazonaws.directoryservice#AcceptSharedDirectory" }, { "target": "com.amazonaws.directoryservice#AddIpRoutes" }, { "target": "com.amazonaws.directoryservice#AddRegion" }, { "target": "com.amazonaws.directoryservice#AddTagsToResource" }, { "target": "com.amazonaws.directoryservice#CancelSchemaExtension" }, { "target": "com.amazonaws.directoryservice#ConnectDirectory" }, { "target": "com.amazonaws.directoryservice#CreateAlias" }, { "target": "com.amazonaws.directoryservice#CreateComputer" }, { "target": "com.amazonaws.directoryservice#CreateConditionalForwarder" }, { "target": "com.amazonaws.directoryservice#CreateDirectory" }, { "target": "com.amazonaws.directoryservice#CreateHybridAD" }, { "target": "com.amazonaws.directoryservice#CreateLogSubscription" }, { "target": "com.amazonaws.directoryservice#CreateMicrosoftAD" }, { "target": "com.amazonaws.directoryservice#CreateSnapshot" }, { "target": "com.amazonaws.directoryservice#CreateTrust" }, { "target": "com.amazonaws.directoryservice#DeleteADAssessment" }, { "target": "com.amazonaws.directoryservice#DeleteConditionalForwarder" }, { "target": "com.amazonaws.directoryservice#DeleteDirectory" }, { "target": "com.amazonaws.directoryservice#DeleteLogSubscription" }, { "target": "com.amazonaws.directoryservice#DeleteSnapshot" }, { "target": "com.amazonaws.directoryservice#DeleteTrust" }, { "target": "com.amazonaws.directoryservice#DeregisterCertificate" }, { "target": "com.amazonaws.directoryservice#DeregisterEventTopic" }, { "target": "com.amazonaws.directoryservice#DescribeADAssessment" }, { "target": "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicy" }, { "target": "com.amazonaws.directoryservice#DescribeCertificate" }, { "target": "com.amazonaws.directoryservice#DescribeClientAuthenticationSettings" }, { "target": "com.amazonaws.directoryservice#DescribeConditionalForwarders" }, { "target": "com.amazonaws.directoryservice#DescribeDirectories" }, { "target": "com.amazonaws.directoryservice#DescribeDirectoryDataAccess" }, { "target": "com.amazonaws.directoryservice#DescribeDomainControllers" }, { "target": "com.amazonaws.directoryservice#DescribeEventTopics" }, { "target": "com.amazonaws.directoryservice#DescribeHybridADUpdate" }, { "target": "com.amazonaws.directoryservice#DescribeLDAPSSettings" }, { "target": "com.amazonaws.directoryservice#DescribeRegions" }, { "target": "com.amazonaws.directoryservice#DescribeSettings" }, { "target": "com.amazonaws.directoryservice#DescribeSharedDirectories" }, { "target": "com.amazonaws.directoryservice#DescribeSnapshots" }, { "target": "com.amazonaws.directoryservice#DescribeTrusts" }, { "target": "com.amazonaws.directoryservice#DescribeUpdateDirectory" }, { "target": "com.amazonaws.directoryservice#DisableCAEnrollmentPolicy" }, { "target": "com.amazonaws.directoryservice#DisableClientAuthentication" }, { "target": "com.amazonaws.directoryservice#DisableDirectoryDataAccess" }, { "target": "com.amazonaws.directoryservice#DisableLDAPS" }, { "target": "com.amazonaws.directoryservice#DisableRadius" }, { "target": "com.amazonaws.directoryservice#DisableSso" }, { "target": "com.amazonaws.directoryservice#EnableCAEnrollmentPolicy" }, { "target": "com.amazonaws.directoryservice#EnableClientAuthentication" }, { "target": "com.amazonaws.directoryservice#EnableDirectoryDataAccess" }, { "target": "com.amazonaws.directoryservice#EnableLDAPS" }, { "target": "com.amazonaws.directoryservice#EnableRadius" }, { "target": "com.amazonaws.directoryservice#EnableSso" }, { "target": "com.amazonaws.directoryservice#GetDirectoryLimits" }, { "target": "com.amazonaws.directoryservice#GetSnapshotLimits" }, { "target": "com.amazonaws.directoryservice#ListADAssessments" }, { "target": "com.amazonaws.directoryservice#ListCertificates" }, { "target": "com.amazonaws.directoryservice#ListIpRoutes" }, { "target": "com.amazonaws.directoryservice#ListLogSubscriptions" }, { "target": "com.amazonaws.directoryservice#ListSchemaExtensions" }, { "target": "com.amazonaws.directoryservice#ListTagsForResource" }, { "target": "com.amazonaws.directoryservice#RegisterCertificate" }, { "target": "com.amazonaws.directoryservice#RegisterEventTopic" }, { "target": "com.amazonaws.directoryservice#RejectSharedDirectory" }, { "target": "com.amazonaws.directoryservice#RemoveIpRoutes" }, { "target": "com.amazonaws.directoryservice#RemoveRegion" }, { "target": "com.amazonaws.directoryservice#RemoveTagsFromResource" }, { "target": "com.amazonaws.directoryservice#ResetUserPassword" }, { "target": "com.amazonaws.directoryservice#RestoreFromSnapshot" }, { "target": "com.amazonaws.directoryservice#ShareDirectory" }, { "target": "com.amazonaws.directoryservice#StartADAssessment" }, { "target": "com.amazonaws.directoryservice#StartSchemaExtension" }, { "target": "com.amazonaws.directoryservice#UnshareDirectory" }, { "target": "com.amazonaws.directoryservice#UpdateConditionalForwarder" }, { "target": "com.amazonaws.directoryservice#UpdateDirectorySetup" }, { "target": "com.amazonaws.directoryservice#UpdateHybridAD" }, { "target": "com.amazonaws.directoryservice#UpdateNumberOfDomainControllers" }, { "target": "com.amazonaws.directoryservice#UpdateRadius" }, { "target": "com.amazonaws.directoryservice#UpdateSettings" }, { "target": "com.amazonaws.directoryservice#UpdateTrust" }, { "target": "com.amazonaws.directoryservice#VerifyTrust" } ], "traits": { "aws.api#service": { "sdkId": "Directory Service", "arnNamespace": "ds", "cloudFormationName": "DirectoryService", "cloudTrailEventSource": "ds.amazonaws.com", "docId": "ds-2015-04-16", "endpointPrefix": "ds" }, "aws.auth#sigv4": { "name": "ds" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Directory Service\n

Directory Service is a web service that makes it easy for you to setup and run directories in the\n Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active\n Directory. This guide provides detailed information about Directory Service operations, data types,\n parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service\n Administration Guide.

\n \n

Amazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs\n provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.

\n
", "smithy.api#title": "AWS Directory Service", "smithy.api#xmlNamespace": { "uri": "http://directoryservice.amazonaws.com/doc/2015-04-16/" }, "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://ds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ds-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ds.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ds.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://ds.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.directoryservice#DirectoryShortName": { "type": "string", "traits": { "smithy.api#pattern": "^[^\\\\/:*?\"<>|.]+[^\\\\/:*?\"<>|]*$" } }, "com.amazonaws.directoryservice#DirectorySize": { "type": "enum", "members": { "SMALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Small" } }, "LARGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Large" } } } }, "com.amazonaws.directoryservice#DirectorySizeUpdateSettings": { "type": "structure", "members": { "DirectorySize": { "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { "smithy.api#documentation": "

The target directory size for the update operation.

" } } }, "traits": { "smithy.api#documentation": "

Contains the directory size configuration for update operations.

" } }, "com.amazonaws.directoryservice#DirectoryStage": { "type": "enum", "members": { "REQUESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Requested" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Creating" } }, "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Created" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "INOPERABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Inoperable" } }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Impaired" } }, "RESTORING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Restoring" } }, "RESTOREFAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RestoreFailed" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleting" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleted" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updating" } } } }, "com.amazonaws.directoryservice#DirectoryType": { "type": "enum", "members": { "SIMPLE_AD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SimpleAD" } }, "AD_CONNECTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADConnector" } }, "MICROSOFT_AD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MicrosoftAD" } }, "SHARED_MICROSOFT_AD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SharedMicrosoftAD" } } } }, "com.amazonaws.directoryservice#DirectoryUnavailableException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified directory is unavailable.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DirectoryVpcSettings": { "type": "structure", "members": { "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC in which to create the directory.

", "smithy.api#required": {} } }, "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { "smithy.api#documentation": "

The identifiers of the subnets for the directory servers. The two subnets must be in\n different Availability Zones. Directory Service creates a directory server and a DNS server in each of\n these subnets.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains VPC information for the CreateDirectory, CreateMicrosoftAD, or CreateHybridAD operation.

" } }, "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription": { "type": "structure", "members": { "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC that the directory is in.

" } }, "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { "smithy.api#documentation": "

The identifiers of the subnets for the directory servers.

" } }, "SecurityGroupId": { "target": "com.amazonaws.directoryservice#SecurityGroupId", "traits": { "smithy.api#documentation": "

The domain controller security group identifier for the directory.

" } }, "AvailabilityZones": { "target": "com.amazonaws.directoryservice#AvailabilityZones", "traits": { "smithy.api#documentation": "

The list of Availability Zones that the directory is in.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the directory.

" } }, "com.amazonaws.directoryservice#DisableAlreadyInProgressException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

A disable operation for CA enrollment policy is already in progress for this directory.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DisableCAEnrollmentPolicy": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyRequest" }, "output": { "target": "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#DisableAlreadyInProgressException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Disables the certificate authority (CA) enrollment policy for the specified directory. This stops\n automatic certificate enrollment and management for domain-joined clients, but does not affect\n existing certificates.

\n \n

Disabling the CA enrollment policy prevents new certificates from being automatically\n enrolled, but existing certificates remain valid and functional until they expire.

\n
" } }, "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to disable the CA enrollment policy.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DisableCAEnrollmentPolicy operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the DisableCAEnrollmentPolicy operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DisableClientAuthentication": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DisableClientAuthenticationRequest" }, "output": { "target": "com.amazonaws.directoryservice#DisableClientAuthenticationResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidClientAuthStatusException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Disables alternative client authentication methods for the specified directory.

" } }, "com.amazonaws.directoryservice#DisableClientAuthenticationRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { "smithy.api#documentation": "

The type of client authentication to disable. Currently the only parameter\n \"SmartCard\" is supported.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DisableClientAuthenticationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DisableDirectoryDataAccess": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DisableDirectoryDataAccessRequest" }, "output": { "target": "com.amazonaws.directoryservice#DisableDirectoryDataAccessResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryInDesiredStateException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deactivates access to directory data via the Directory Service Data API for the specified directory. For\n more information, see Directory Service Data API Reference.

" } }, "com.amazonaws.directoryservice#DisableDirectoryDataAccessRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DisableDirectoryDataAccessResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DisableLDAPS": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DisableLDAPSRequest" }, "output": { "target": "com.amazonaws.directoryservice#DisableLDAPSResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#InvalidLDAPSStatusException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Deactivates LDAP secure calls for the specified directory.

" } }, "com.amazonaws.directoryservice#DisableLDAPSRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#LDAPSType", "traits": { "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is\n supported.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DisableLDAPSResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DisableRadius": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DisableRadiusRequest" }, "output": { "target": "com.amazonaws.directoryservice#DisableRadiusResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User\n Service (RADIUS) server for an AD Connector or Microsoft AD directory.

", "smithy.api#examples": [ { "title": "To disable radius", "documentation": "The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", "input": { "DirectoryId": "d-92654abfed" }, "output": {} } ] } }, "com.amazonaws.directoryservice#DisableRadiusRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to disable MFA.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DisableRadius operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DisableRadiusResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the DisableRadius operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DisableSso": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#DisableSsoRequest" }, "output": { "target": "com.amazonaws.directoryservice#DisableSsoResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AuthenticationFailedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InsufficientPermissionsException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Disables single-sign on for a directory.

", "smithy.api#examples": [ { "title": "To disable SSO", "documentation": "The following example disables single sign-on for a specified directory.", "input": { "DirectoryId": "d-92654abfed", "UserName": "Admin", "Password": "Str0ngP@ssw0rd" }, "output": {} } ] } }, "com.amazonaws.directoryservice#DisableSsoRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to disable single-sign on.

", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { "smithy.api#documentation": "

The username of an alternate account to use to disable single-sign on. This is only used\n for AD Connector directories. This account must have privileges to remove a service\n principal name.

\n

If the AD Connector service account does not have privileges to remove a service\n principal name, you can specify an alternate account with the UserName\n and Password parameters. These credentials are only used to disable\n single sign-on and are not stored by the service. The AD Connector service account is not\n changed.

" } }, "Password": { "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { "smithy.api#documentation": "

The password of an alternate account to use to disable single-sign on. This is only used\n for AD Connector directories. For more information, see the UserName\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the DisableSso operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#DisableSsoResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the DisableSso operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#DnsIpAddrs": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#IpAddr" } }, "com.amazonaws.directoryservice#DnsIpv6Addrs": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Ipv6Addr" } }, "com.amazonaws.directoryservice#DomainController": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory where the domain controller resides.

" } }, "DomainControllerId": { "target": "com.amazonaws.directoryservice#DomainControllerId", "traits": { "smithy.api#documentation": "

Identifies a specific domain controller in the directory.

" } }, "DnsIpAddr": { "target": "com.amazonaws.directoryservice#IpAddr", "traits": { "smithy.api#documentation": "

The IP address of the domain controller.

" } }, "DnsIpv6Addr": { "target": "com.amazonaws.directoryservice#Ipv6Addr", "traits": { "smithy.api#documentation": "

The IPv6 address of the domain controller.

" } }, "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC that contains the domain controller.

" } }, "SubnetId": { "target": "com.amazonaws.directoryservice#SubnetId", "traits": { "smithy.api#documentation": "

Identifier of the subnet in the VPC that contains the domain controller.

" } }, "AvailabilityZone": { "target": "com.amazonaws.directoryservice#AvailabilityZone", "traits": { "smithy.api#documentation": "

The Availability Zone where the domain controller is located.

" } }, "Status": { "target": "com.amazonaws.directoryservice#DomainControllerStatus", "traits": { "smithy.api#documentation": "

The status of the domain controller.

" } }, "StatusReason": { "target": "com.amazonaws.directoryservice#DomainControllerStatusReason", "traits": { "smithy.api#documentation": "

A description of the domain controller state.

" } }, "LaunchTime": { "target": "com.amazonaws.directoryservice#LaunchTime", "traits": { "smithy.api#documentation": "

Specifies when the domain controller was created.

" } }, "StatusLastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the status was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the domain controllers for a specified directory.

" } }, "com.amazonaws.directoryservice#DomainControllerId": { "type": "string", "traits": { "smithy.api#pattern": "^dc-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#DomainControllerIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#DomainControllerId" } }, "com.amazonaws.directoryservice#DomainControllerLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The maximum allowed number of domain controllers per directory was exceeded. The\n default limit per directory is 20 domain controllers.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#DomainControllerStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Creating" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Impaired" } }, "RESTORING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Restoring" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleting" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleted" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updating" } } } }, "com.amazonaws.directoryservice#DomainControllerStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#DomainControllers": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#DomainController" } }, "com.amazonaws.directoryservice#EnableAlreadyInProgressException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

An enable operation for CA enrollment policy is already in progress for this directory.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#EnableCAEnrollmentPolicy": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyRequest" }, "output": { "target": "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EnableAlreadyInProgressException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Enables certificate authority (CA) enrollment policy for the specified directory. This allows\n domain-joined clients to automatically request and receive certificates from the specified\n Amazon Web Services Private Certificate Authority.

\n \n

Before enabling CA enrollment, ensure that the PCA connector is properly configured and\n accessible from the directory. The connector must be in an active state and have the\n necessary permissions.

\n
" } }, "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to enable the CA enrollment policy.

", "smithy.api#required": {} } }, "PcaConnectorArn": { "target": "com.amazonaws.directoryservice#PcaConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Private Certificate Authority (PCA) connector to use\n for automatic certificate enrollment. This connector must be properly configured and\n accessible from the directory.

\n

The ARN format is:\n arn:aws:pca-connector-ad:region:account-id:connector/connector-id\n \n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the EnableCAEnrollmentPolicy operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the EnableCAEnrollmentPolicy operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#EnableClientAuthentication": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#EnableClientAuthenticationRequest" }, "output": { "target": "com.amazonaws.directoryservice#EnableClientAuthenticationResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidClientAuthStatusException" }, { "target": "com.amazonaws.directoryservice#NoAvailableCertificateException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Enables alternative client authentication methods for the specified directory.

" } }, "com.amazonaws.directoryservice#EnableClientAuthenticationRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the specified directory.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { "smithy.api#documentation": "

The type of client authentication to enable. Currently only the value\n SmartCard is supported. Smart card authentication in AD Connector requires\n that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in\n your self-managed AD.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#EnableClientAuthenticationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#EnableDirectoryDataAccess": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#EnableDirectoryDataAccessRequest" }, "output": { "target": "com.amazonaws.directoryservice#EnableDirectoryDataAccessResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryInDesiredStateException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Enables access to directory data via the Directory Service Data API for the specified directory. For\n more information, see Directory Service Data API Reference.

" } }, "com.amazonaws.directoryservice#EnableDirectoryDataAccessRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory identifier.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#EnableDirectoryDataAccessResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#EnableLDAPS": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#EnableLDAPSRequest" }, "output": { "target": "com.amazonaws.directoryservice#EnableLDAPSResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#InvalidLDAPSStatusException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#NoAvailableCertificateException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Activates the switch for the specific directory to always use LDAP secure calls.

" } }, "com.amazonaws.directoryservice#EnableLDAPSRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#LDAPSType", "traits": { "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is\n supported.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#EnableLDAPSResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#EnableRadius": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#EnableRadiusRequest" }, "output": { "target": "com.amazonaws.directoryservice#EnableRadiusResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User\n Service (RADIUS) server for an AD Connector or Microsoft AD directory.

", "smithy.api#examples": [ { "title": "To enable radius", "documentation": "The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", "input": { "DirectoryId": "d-92654abfed", "RadiusSettings": { "DisplayLabel": "MyRadius", "UseSameUsername": true, "RadiusTimeout": 1, "AuthenticationProtocol": "PAP", "RadiusPort": 1200, "RadiusRetries": 2, "SharedSecret": "123456789", "RadiusServers": [ "172.168.111.12" ] } }, "output": {} } ] } }, "com.amazonaws.directoryservice#EnableRadiusRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to enable MFA.

", "smithy.api#required": {} } }, "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS\n server.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the EnableRadius operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#EnableRadiusResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the EnableRadius operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#EnableSso": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#EnableSsoRequest" }, "output": { "target": "com.amazonaws.directoryservice#EnableSsoResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AuthenticationFailedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InsufficientPermissionsException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Enables single sign-on for a directory. Single sign-on allows users in your directory to\n access certain Amazon Web Services services from a computer joined to the directory without having to enter\n their credentials separately.

", "smithy.api#examples": [ { "title": "To enable SSO", "documentation": "To enable single sign-on for a specified directory.", "input": { "DirectoryId": "d-92654abfed", "UserName": "Admin", "Password": "Str0ngP@ssw0rd" }, "output": {} } ] } }, "com.amazonaws.directoryservice#EnableSsoRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to enable single-sign on.

", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { "smithy.api#documentation": "

The username of an alternate account to use to enable single-sign on. This is only used\n for AD Connector directories. This account must have privileges to add a service principal\n name.

\n

If the AD Connector service account does not have privileges to add a service principal\n name, you can specify an alternate account with the UserName and\n Password parameters. These credentials are only used to enable single\n sign-on and are not stored by the service. The AD Connector service account is not\n changed.

" } }, "Password": { "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { "smithy.api#documentation": "

The password of an alternate account to use to enable single-sign on. This is only used\n for AD Connector directories. For more information, see the UserName\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the EnableSso operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#EnableSsoResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the EnableSso operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#EndDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#EntityAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified entity already exists.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#EntityDoesNotExistException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified entity could not be found.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#EventTopic": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS\n topic.

" } }, "TopicName": { "target": "com.amazonaws.directoryservice#TopicName", "traits": { "smithy.api#documentation": "

The name of an Amazon SNS topic the receives status messages from the directory.

" } }, "TopicArn": { "target": "com.amazonaws.directoryservice#TopicArn", "traits": { "smithy.api#documentation": "

The Amazon SNS topic ARN (Amazon Resource Name).

" } }, "CreatedDateTime": { "target": "com.amazonaws.directoryservice#CreatedDateTime", "traits": { "smithy.api#documentation": "

The date and time of when you associated your directory with the Amazon SNS topic.

" } }, "Status": { "target": "com.amazonaws.directoryservice#TopicStatus", "traits": { "smithy.api#documentation": "

The topic registration status.

" } } }, "traits": { "smithy.api#documentation": "

Information about Amazon SNS topic and Directory Service directory associations.

" } }, "com.amazonaws.directoryservice#EventTopics": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#EventTopic" } }, "com.amazonaws.directoryservice#ExceptionMessage": { "type": "string", "traits": { "smithy.api#documentation": "

The descriptive message for the exception.

" } }, "com.amazonaws.directoryservice#GetDirectoryLimits": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#GetDirectoryLimitsRequest" }, "output": { "target": "com.amazonaws.directoryservice#GetDirectoryLimitsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Obtains directory limit information for the current Region.

", "smithy.api#examples": [ { "title": "To get directory limits", "documentation": "The following example obtains directory limit information for the current region.", "output": { "DirectoryLimits": { "CloudOnlyDirectoriesCurrentCount": 2, "CloudOnlyDirectoriesLimit": 10, "CloudOnlyDirectoriesLimitReached": false, "CloudOnlyMicrosoftADCurrentCount": 2, "CloudOnlyMicrosoftADLimit": 10, "CloudOnlyMicrosoftADLimitReached": false, "ConnectedDirectoriesCurrentCount": 1, "ConnectedDirectoriesLimit": 10, "ConnectedDirectoriesLimitReached": false } } } ] } }, "com.amazonaws.directoryservice#GetDirectoryLimitsRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the inputs for the GetDirectoryLimits operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#GetDirectoryLimitsResult": { "type": "structure", "members": { "DirectoryLimits": { "target": "com.amazonaws.directoryservice#DirectoryLimits", "traits": { "smithy.api#documentation": "

A DirectoryLimits object that contains the directory limits for the\n current Region.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the GetDirectoryLimits operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#GetSnapshotLimits": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#GetSnapshotLimitsRequest" }, "output": { "target": "com.amazonaws.directoryservice#GetSnapshotLimitsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Obtains the manual snapshot limits for a directory.

", "smithy.api#examples": [ { "title": "To get snapshot limits", "documentation": "The following example obtains the manual snapshot limits for a specified directory.", "input": { "DirectoryId": "d-92654abfed" }, "output": { "SnapshotLimits": { "ManualSnapshotsCurrentCount": 1, "ManualSnapshotsLimit": 5, "ManualSnapshotsLimitReached": false } } } ] } }, "com.amazonaws.directoryservice#GetSnapshotLimitsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Contains the identifier of the directory to obtain the limits for.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the GetSnapshotLimits operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#GetSnapshotLimitsResult": { "type": "structure", "members": { "SnapshotLimits": { "target": "com.amazonaws.directoryservice#SnapshotLimits", "traits": { "smithy.api#documentation": "

A SnapshotLimits object that contains the manual snapshot limits for the specified\n directory.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of the GetSnapshotLimits operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#HybridAdministratorAccountUpdate": { "type": "structure", "members": { "SecretArn": { "target": "com.amazonaws.directoryservice#SecretArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials for the AD administrator user, and enables hybrid domain controllers to\n join the managed AD domain. For example:

\n

\n \n {\"customerAdAdminDomainUsername\":\"carlos_salazar\",\"customerAdAdminDomainPassword\":\"ExamplePassword123!\"}.\n \n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Use to recover to the hybrid directory administrator account credentials.

" } }, "com.amazonaws.directoryservice#HybridCustomerInstancesSettings": { "type": "structure", "members": { "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#CustomerDnsIps", "traits": { "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in your self-managed AD\n environment.

", "smithy.api#required": {} } }, "InstanceIds": { "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", "traits": { "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM used in hybrid\n directory.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains configuration settings for self-managed instances with SSM used in hybrid\n directory operations.

" } }, "com.amazonaws.directoryservice#HybridSettingsDescription": { "type": "structure", "members": { "SelfManagedDnsIpAddrs": { "target": "com.amazonaws.directoryservice#IpAddrs", "traits": { "smithy.api#documentation": "

The IP addresses of the DNS servers in your self-managed AD environment.

" } }, "SelfManagedInstanceIds": { "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", "traits": { "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM used for hybrid directory\n operations.

" } } }, "traits": { "smithy.api#documentation": "

Describes the current hybrid directory configuration settings for a directory.

" } }, "com.amazonaws.directoryservice#HybridUpdateActivities": { "type": "structure", "members": { "SelfManagedInstances": { "target": "com.amazonaws.directoryservice#HybridUpdateInfoEntries", "traits": { "smithy.api#documentation": "

A list of update activities related to the self-managed instances with SSM in the\n self-managed instances with SSM hybrid directory configuration.

" } }, "HybridAdministratorAccount": { "target": "com.amazonaws.directoryservice#HybridUpdateInfoEntries", "traits": { "smithy.api#documentation": "

A list of update activities related to hybrid directory administrator account\n changes.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about update activities for different components of a hybrid\n directory.

" } }, "com.amazonaws.directoryservice#HybridUpdateInfoEntries": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#HybridUpdateInfoEntry" } }, "com.amazonaws.directoryservice#HybridUpdateInfoEntry": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.directoryservice#UpdateStatus", "traits": { "smithy.api#documentation": "

The current status of the update activity. Valid values include UPDATED,\n UPDATING, and UPDATE_FAILED.

" } }, "StatusReason": { "target": "com.amazonaws.directoryservice#UpdateStatusReason", "traits": { "smithy.api#documentation": "

A human-readable description of the update status, including any error details or\n progress information.

" } }, "InitiatedBy": { "target": "com.amazonaws.directoryservice#InitiatedBy", "traits": { "smithy.api#documentation": "

Specifies if the update was initiated by the customer or Amazon Web Services.

" } }, "NewValue": { "target": "com.amazonaws.directoryservice#HybridUpdateValue", "traits": { "smithy.api#documentation": "

The new configuration values being applied in this update.

" } }, "PreviousValue": { "target": "com.amazonaws.directoryservice#HybridUpdateValue", "traits": { "smithy.api#documentation": "

The previous configuration values before this update was applied.

" } }, "StartTime": { "target": "com.amazonaws.directoryservice#StartDateTime", "traits": { "smithy.api#documentation": "

The date and time when the update activity was initiated.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the update activity status was last updated.

" } }, "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The identifier of the assessment performed to validate this update\n configuration.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a specific update activity for a hybrid directory\n component.

" } }, "com.amazonaws.directoryservice#HybridUpdateType": { "type": "enum", "members": { "SELF_MANAGED_INSTANCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SelfManagedInstances" } }, "HYBRID_ADMINISTRATOR_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HybridAdministratorAccount" } } } }, "com.amazonaws.directoryservice#HybridUpdateValue": { "type": "structure", "members": { "InstanceIds": { "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", "traits": { "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM in the hybrid directory\n configuration.

" } }, "DnsIps": { "target": "com.amazonaws.directoryservice#CustomerDnsIps", "traits": { "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in the hybrid directory\n configuration.

" } } }, "traits": { "smithy.api#documentation": "

Contains the configuration values for a hybrid directory update, including Amazon Web Services\n System Manager managed node and DNS information.

" } }, "com.amazonaws.directoryservice#IncompatibleSettingsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified directory setting is not compatible with other settings.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InitiatedBy": { "type": "string" }, "com.amazonaws.directoryservice#InsufficientPermissionsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The account does not have sufficient permission to perform the operation.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidCertificateException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The certificate PEM that was provided has incorrect encoding.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidClientAuthStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

Client authentication is already enabled.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidLDAPSStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The LDAP activities could not be performed because they are limited by the LDAPS\n status.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The NextToken value is not valid.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidParameterException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

One or more parameters are not valid.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidPasswordException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The new password provided by the user does not meet the password complexity\n requirements defined in your directory.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#InvalidTargetException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified shared target is not valid.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#IpAddr": { "type": "string", "traits": { "smithy.api#pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" } }, "com.amazonaws.directoryservice#IpAddrs": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#IpAddr" } }, "com.amazonaws.directoryservice#IpRoute": { "type": "structure", "members": { "CidrIp": { "target": "com.amazonaws.directoryservice#CidrIp", "traits": { "smithy.api#documentation": "

IP address block in CIDR format, such as 10.0.0.0/24. This is often the address block of\n the DNS server used for your self-managed domain. For a single IP address, use a CIDR\n address block with /32. For example, 10.0.0.0/32.

" } }, "CidrIpv6": { "target": "com.amazonaws.directoryservice#CidrIpv6", "traits": { "smithy.api#documentation": "

IPv6 address block in CIDR format, such as 2001:db8::/32. This is often the address\n block of the DNS server used for your self-managed domain. For a single IPv6 address, use a\n CIDR address block with /128. For example, 2001:db8::1/128.

" } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

Description of the address block.

" } } }, "traits": { "smithy.api#documentation": "

Contains the IP address block. This is often the address block of the DNS server used\n for your self-managed domain.

" } }, "com.amazonaws.directoryservice#IpRouteInfo": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory associated with the IP addresses.

" } }, "CidrIp": { "target": "com.amazonaws.directoryservice#CidrIp", "traits": { "smithy.api#documentation": "

IP address block in the IpRoute.

" } }, "CidrIpv6": { "target": "com.amazonaws.directoryservice#CidrIpv6", "traits": { "smithy.api#documentation": "

IPv6 address block in the IpRoute.

" } }, "IpRouteStatusMsg": { "target": "com.amazonaws.directoryservice#IpRouteStatusMsg", "traits": { "smithy.api#documentation": "

The status of the IP address block.

" } }, "AddedDateTime": { "target": "com.amazonaws.directoryservice#AddedDateTime", "traits": { "smithy.api#documentation": "

The date and time the address block was added to the directory.

" } }, "IpRouteStatusReason": { "target": "com.amazonaws.directoryservice#IpRouteStatusReason", "traits": { "smithy.api#documentation": "

The reason for the IpRouteStatusMsg.

" } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

Description of the IpRouteInfo.

" } } }, "traits": { "smithy.api#documentation": "

Information about one or more IP address blocks.

" } }, "com.amazonaws.directoryservice#IpRouteLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP\n address blocks.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#IpRouteStatusMsg": { "type": "enum", "members": { "ADDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Adding" } }, "ADDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Added" } }, "REMOVING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Removing" } }, "REMOVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Removed" } }, "ADD_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AddFailed" } }, "REMOVE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RemoveFailed" } } } }, "com.amazonaws.directoryservice#IpRouteStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#IpRoutes": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#IpRoute" } }, "com.amazonaws.directoryservice#IpRoutesInfo": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#IpRouteInfo" } }, "com.amazonaws.directoryservice#IpV6Addrs": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Ipv6Addr" } }, "com.amazonaws.directoryservice#Ipv6Addr": { "type": "string", "traits": { "smithy.api#pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$" } }, "com.amazonaws.directoryservice#LDAPSSettingInfo": { "type": "structure", "members": { "LDAPSStatus": { "target": "com.amazonaws.directoryservice#LDAPSStatus", "traits": { "smithy.api#documentation": "

The state of the LDAPS settings.

" } }, "LDAPSStatusReason": { "target": "com.amazonaws.directoryservice#LDAPSStatusReason", "traits": { "smithy.api#documentation": "

Describes a state change for LDAPS.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the LDAPS settings were last updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains general information about the LDAPS settings.

" } }, "com.amazonaws.directoryservice#LDAPSSettingsInfo": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#LDAPSSettingInfo" } }, "com.amazonaws.directoryservice#LDAPSStatus": { "type": "enum", "members": { "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabling" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "ENABLE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EnableFailed" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.directoryservice#LDAPSStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#LDAPSType": { "type": "enum", "members": { "CLIENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Client" } } } }, "com.amazonaws.directoryservice#LastUpdateDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#LastUpdatedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#LaunchTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#LdifContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500000 } } }, "com.amazonaws.directoryservice#Limit": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.directoryservice#ListADAssessments": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ListADAssessmentsRequest" }, "output": { "target": "com.amazonaws.directoryservice#ListADAssessmentsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Retrieves a list of directory assessments for the specified directory or all\n assessments in your account. Use this operation to monitor assessment status and manage\n multiple assessments.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Assessments", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#ListADAssessmentsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to list assessments. If not specified, all\n assessments in your account are returned.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The pagination token from a previous request to ListADAssessments.\n Pass null if this is the first request.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#AssessmentLimit", "traits": { "smithy.api#documentation": "

The maximum number of assessment summaries to return.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ListADAssessmentsResult": { "type": "structure", "members": { "Assessments": { "target": "com.amazonaws.directoryservice#Assessments", "traits": { "smithy.api#documentation": "

A list of assessment summaries containing basic information about each directory\n assessment.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent request to retrieve the next set of\n items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ListCertificates": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ListCertificatesRequest" }, "output": { "target": "com.amazonaws.directoryservice#ListCertificatesResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

For the specified directory, lists all the certificates registered for a secure LDAP or\n client certificate authentication.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "CertificatesInfo", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#ListCertificatesRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

A token for requesting another page of certificates if the NextToken response\n element indicates that more certificates are available. Use the value of the returned\n NextToken element in your request until the token comes back as\n null. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#PageLimit", "traits": { "smithy.api#documentation": "

The number of items that should show up on one page

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ListCertificatesResult": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

Indicates whether another page of certificates is available when the number of available\n certificates exceeds the page limit.

" } }, "CertificatesInfo": { "target": "com.amazonaws.directoryservice#CertificatesInfo", "traits": { "smithy.api#documentation": "

A list of certificates with basic details including certificate ID, certificate common\n name, certificate state.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ListIpRoutes": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ListIpRoutesRequest" }, "output": { "target": "com.amazonaws.directoryservice#ListIpRoutesResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Lists the address blocks that you have added to a directory.

", "smithy.api#examples": [ { "title": "To list IP routes", "documentation": "The following example lists the address blocks that have been added to a specified directory.", "input": { "DirectoryId": "d-92654abfed", "Limit": 0 }, "output": { "IpRoutesInfo": [ { "AddedDateTime": 1481577631.63, "CidrIp": "12.12.12.12/32", "Description": "example", "DirectoryId": "d-92654abfed", "IpRouteStatusMsg": "Added" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "IpRoutesInfo", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#ListIpRoutesRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

Maximum number of items to return. If this value is zero, the maximum number of items is\n specified by the limitations of the operation.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ListIpRoutesResult": { "type": "structure", "members": { "IpRoutesInfo": { "target": "com.amazonaws.directoryservice#IpRoutesInfo", "traits": { "smithy.api#documentation": "

A list of IpRoutes.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ListLogSubscriptions": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ListLogSubscriptionsRequest" }, "output": { "target": "com.amazonaws.directoryservice#ListLogSubscriptionsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Lists the active log subscriptions for the Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "LogSubscriptions", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#ListLogSubscriptionsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

If a DirectoryID is provided, lists only the log subscription\n associated with that directory. If no DirectoryId is provided, lists all\n log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for\n the Amazon Web Services account or the directory, an empty list will be returned.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of items to return.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of items returned.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ListLogSubscriptionsResult": { "type": "structure", "members": { "LogSubscriptions": { "target": "com.amazonaws.directoryservice#LogSubscriptions", "traits": { "smithy.api#documentation": "

A list of active LogSubscription objects for calling the\n Amazon Web Services account.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of items to return.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ListSchemaExtensions": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ListSchemaExtensionsRequest" }, "output": { "target": "com.amazonaws.directoryservice#ListSchemaExtensionsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Lists all schema extensions applied to a Microsoft AD Directory.

", "smithy.api#examples": [ { "title": "To list schema extensions", "documentation": "The following example lists all schema extensions applied to a specified Microsoft AD Directory.", "input": { "DirectoryId": "d-92654abfed", "Limit": 0 }, "output": { "SchemaExtensionsInfo": [ { "Description": "example text", "DirectoryId": "d-92654abfed", "EndDateTime": 1481586088.301, "SchemaExtensionId": "e-926731d2a0", "SchemaExtensionStatus": "Cancelled", "SchemaExtensionStatusReason": "Cancellation is complete. No schema updates were applied to your directory.", "StartDateTime": 1481584463.548 } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "SchemaExtensionsInfo", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#ListSchemaExtensionsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory from which to retrieve the schema extension\n information.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The ListSchemaExtensions.NextToken value from a previous call to\n ListSchemaExtensions. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of items to return.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ListSchemaExtensionsResult": { "type": "structure", "members": { "SchemaExtensionsInfo": { "target": "com.amazonaws.directoryservice#SchemaExtensionsInfo", "traits": { "smithy.api#documentation": "

Information about the schema extensions applied to the directory.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter in a subsequent call to ListSchemaExtensions to retrieve the next set\n of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.directoryservice#ListTagsForResourceResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidNextTokenException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Lists all tags on a directory.

", "smithy.api#examples": [ { "title": "To list tags for a directory", "documentation": "The following example lists all tags associated with a specified directory.", "input": { "ResourceId": "d-92654abfed", "Limit": 0 }, "output": { "Tags": [ { "Key": "environment", "Value": "production" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Tags", "pageSize": "Limit" } } }, "com.amazonaws.directoryservice#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.directoryservice#ResourceId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve tags.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

Reserved for future use.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

Reserved for future use.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ListTagsForResourceResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

Reserved for future use.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#LogGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[-._/#A-Za-z0-9]+$" } }, "com.amazonaws.directoryservice#LogSubscription": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory that you want to associate with the log\n subscription.

" } }, "LogGroupName": { "target": "com.amazonaws.directoryservice#LogGroupName", "traits": { "smithy.api#documentation": "

The name of the log group.

" } }, "SubscriptionCreatedDateTime": { "target": "com.amazonaws.directoryservice#SubscriptionCreatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the log subscription was created.

" } } }, "traits": { "smithy.api#documentation": "

Represents a log subscription, which tracks real-time data from a chosen log group to a\n specified destination.

" } }, "com.amazonaws.directoryservice#LogSubscriptions": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#LogSubscription" } }, "com.amazonaws.directoryservice#ManualSnapshotsLimitReached": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#NetworkType": { "type": "enum", "members": { "DUAL_STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Dual-stack" } }, "IPV4_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPv4" } }, "IPV6_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPv6" } } } }, "com.amazonaws.directoryservice#NetworkUpdateSettings": { "type": "structure", "members": { "NetworkType": { "target": "com.amazonaws.directoryservice#NetworkType", "traits": { "smithy.api#documentation": "

The target network type for the directory update.

" } }, "CustomerDnsIpsV6": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

IPv6 addresses of DNS servers or domain controllers in the self-managed directory.\n Required only when updating an AD Connector directory.

" } } }, "traits": { "smithy.api#documentation": "

Contains the network configuration for directory update operations.

" } }, "com.amazonaws.directoryservice#NextToken": { "type": "string" }, "com.amazonaws.directoryservice#NoAvailableCertificateException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

Client authentication setup could not be completed because at least one valid certificate\n must be registered in the system.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#Notes": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#OCSPUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^(https?|ftp|file|ldaps?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;()]*[-a-zA-Z0-9+&@#/%=~_|()]$" } }, "com.amazonaws.directoryservice#OSUpdateSettings": { "type": "structure", "members": { "OSVersion": { "target": "com.amazonaws.directoryservice#OSVersion", "traits": { "smithy.api#documentation": "

OS version that the directory needs to be updated to.

" } } }, "traits": { "smithy.api#documentation": "

OS version that the directory needs to be updated to.

" } }, "com.amazonaws.directoryservice#OSVersion": { "type": "enum", "members": { "VERSION_2012": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVER_2012" } }, "VERSION_2019": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVER_2019" } } } }, "com.amazonaws.directoryservice#OrganizationalUnitDN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.directoryservice#OrganizationsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

Exception encountered while trying to access your Amazon Web Services organization.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#OwnerDirectoryDescription": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the Managed Microsoft AD directory in the directory owner account.

" } }, "AccountId": { "target": "com.amazonaws.directoryservice#CustomerId", "traits": { "smithy.api#documentation": "

Identifier of the directory owner account.

" } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#documentation": "

IP address of the directory\u2019s domain controllers.

" } }, "DnsIpv6Addrs": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

IPv6 addresses of the directory\u2019s domain controllers.

" } }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", "traits": { "smithy.api#documentation": "

Information about the VPC settings for the directory.

" } }, "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { "smithy.api#documentation": "

Information about the RadiusSettings object server configuration.

" } }, "RadiusStatus": { "target": "com.amazonaws.directoryservice#RadiusStatus", "traits": { "smithy.api#documentation": "

The status of the RADIUS server.

" } }, "NetworkType": { "target": "com.amazonaws.directoryservice#NetworkType", "traits": { "smithy.api#documentation": "

Network type of the directory in the directory owner account.

" } } }, "traits": { "smithy.api#documentation": "

Contains the directory owner account details shared with the directory consumer\n account.

" } }, "com.amazonaws.directoryservice#PageLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.directoryservice#Password": { "type": "string", "traits": { "smithy.api#pattern": "^(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^", "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#PcaConnectorArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" } }, "com.amazonaws.directoryservice#PortNumber": { "type": "integer", "traits": { "smithy.api#range": { "min": 1025, "max": 65535 } } }, "com.amazonaws.directoryservice#RadiusAuthenticationProtocol": { "type": "enum", "members": { "PAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAP" } }, "CHAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHAP" } }, "MSCHAPV1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MS-CHAPv1" } }, "MSCHAPV2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MS-CHAPv2" } } } }, "com.amazonaws.directoryservice#RadiusDisplayLabel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.directoryservice#RadiusRetries": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 10 } } }, "com.amazonaws.directoryservice#RadiusSettings": { "type": "structure", "members": { "RadiusServers": { "target": "com.amazonaws.directoryservice#Servers", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints,\n or the FQDN or IP addresses of your RADIUS server load balancer.

" } }, "RadiusServersIpv6": { "target": "com.amazonaws.directoryservice#Servers", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the RADIUS server endpoints or RADIUS server\n load balancer.

" } }, "RadiusPort": { "target": "com.amazonaws.directoryservice#PortNumber", "traits": { "smithy.api#documentation": "

The port that your RADIUS server is using for communications. Your self-managed network\n must allow inbound traffic over this port from the Directory Service servers.

" } }, "RadiusTimeout": { "target": "com.amazonaws.directoryservice#RadiusTimeout", "traits": { "smithy.api#documentation": "

The amount of time, in seconds, to wait for the RADIUS server to respond.

" } }, "RadiusRetries": { "target": "com.amazonaws.directoryservice#RadiusRetries", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of times that communication with the RADIUS server is retried after\n the initial attempt.

" } }, "SharedSecret": { "target": "com.amazonaws.directoryservice#RadiusSharedSecret", "traits": { "smithy.api#documentation": "

Required for enabling RADIUS on the directory.

" } }, "AuthenticationProtocol": { "target": "com.amazonaws.directoryservice#RadiusAuthenticationProtocol", "traits": { "smithy.api#documentation": "

The protocol specified for your RADIUS endpoints.

" } }, "DisplayLabel": { "target": "com.amazonaws.directoryservice#RadiusDisplayLabel", "traits": { "smithy.api#documentation": "

Not currently used.

" } }, "UseSameUsername": { "target": "com.amazonaws.directoryservice#UseSameUsername", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Not currently used.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a Remote Authentication Dial In User Service (RADIUS)\n server.

" } }, "com.amazonaws.directoryservice#RadiusSharedSecret": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 512 }, "smithy.api#pattern": "^(\\p{LD}|\\p{Punct}| )+$", "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#RadiusStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Creating" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.directoryservice#RadiusTimeout": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.directoryservice#RegionDescription": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

" } }, "RegionName": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { "smithy.api#documentation": "

The name of the Region. For example, us-east-1.

" } }, "RegionType": { "target": "com.amazonaws.directoryservice#RegionType", "traits": { "smithy.api#documentation": "

Specifies whether the Region is the primary Region or an additional Region.

" } }, "Status": { "target": "com.amazonaws.directoryservice#DirectoryStage", "traits": { "smithy.api#documentation": "

The status of the replication process for the specified Region.

" } }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettings" }, "DesiredNumberOfDomainControllers": { "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", "traits": { "smithy.api#documentation": "

The desired number of domain controllers in the specified Region for the specified\n directory.

" } }, "LaunchTime": { "target": "com.amazonaws.directoryservice#LaunchTime", "traits": { "smithy.api#documentation": "

Specifies when the Region replication began.

" } }, "StatusLastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#StateLastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the Region status was last updated.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the Region description was last updated.

" } } }, "traits": { "smithy.api#documentation": "

The replicated Region information for a directory.

" } }, "com.amazonaws.directoryservice#RegionLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

You have reached the limit for maximum number of simultaneous Region replications per\n directory.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#RegionName": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 32 } } }, "com.amazonaws.directoryservice#RegionType": { "type": "enum", "members": { "PRIMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Primary" } }, "ADDITIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Additional" } } } }, "com.amazonaws.directoryservice#RegionsDescription": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#RegionDescription" } }, "com.amazonaws.directoryservice#RegionsInfo": { "type": "structure", "members": { "PrimaryRegion": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { "smithy.api#documentation": "

The Region where the Managed Microsoft AD directory was originally created.

" } }, "AdditionalRegions": { "target": "com.amazonaws.directoryservice#AdditionalRegions", "traits": { "smithy.api#documentation": "

Lists the Regions where the directory has been replicated, excluding the primary\n Region.

" } } }, "traits": { "smithy.api#documentation": "

Provides information about the Regions that are configured for multi-Region\n replication.

" } }, "com.amazonaws.directoryservice#RegisterCertificate": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RegisterCertificateRequest" }, "output": { "target": "com.amazonaws.directoryservice#RegisterCertificateResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#CertificateAlreadyExistsException" }, { "target": "com.amazonaws.directoryservice#CertificateLimitExceededException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#InvalidCertificateException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Registers a certificate for a secure LDAP or client certificate authentication.

" } }, "com.amazonaws.directoryservice#RegisterCertificateRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, "CertificateData": { "target": "com.amazonaws.directoryservice#CertificateData", "traits": { "smithy.api#documentation": "

The certificate PEM string that needs to be registered.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#CertificateType", "traits": { "smithy.api#documentation": "

The function that the registered certificate performs. Valid values include\n ClientLDAPS or ClientCertAuth. The default value is\n ClientLDAPS.

" } }, "ClientCertAuthSettings": { "target": "com.amazonaws.directoryservice#ClientCertAuthSettings", "traits": { "smithy.api#documentation": "

A ClientCertAuthSettings object that contains client certificate\n authentication settings.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RegisterCertificateResult": { "type": "structure", "members": { "CertificateId": { "target": "com.amazonaws.directoryservice#CertificateId", "traits": { "smithy.api#documentation": "

The identifier of the certificate.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#RegisterEventTopic": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RegisterEventTopicRequest" }, "output": { "target": "com.amazonaws.directoryservice#RegisterEventTopicResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Associates a directory with an Amazon SNS topic. This establishes the directory as a\n publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when\n the status of your directory changes. You get notified if your directory goes from an Active\n status to an Impaired or Inoperable status. You also receive a notification when the directory\n returns to an Active status.

", "smithy.api#examples": [ { "title": "To register an event topic", "documentation": "The following example associates a directory with an SNS topic.", "input": { "DirectoryId": "d-92654abfed", "TopicName": "snstopicexample" }, "output": {} } ] } }, "com.amazonaws.directoryservice#RegisterEventTopicRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID that will publish status messages to the Amazon SNS topic.

", "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.directoryservice#TopicName", "traits": { "smithy.api#documentation": "

The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS\n topic must be in the same region as the specified Directory ID.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Registers a new event topic.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RegisterEventTopicResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The result of a RegisterEventTopic request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#RejectSharedDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RejectSharedDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#RejectSharedDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryAlreadySharedException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Rejects a directory sharing request that was sent from the directory owner account.

" } }, "com.amazonaws.directoryservice#RejectSharedDirectoryRequest": { "type": "structure", "members": { "SharedDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the shared directory in the directory consumer account. This identifier is\n different for each directory owner account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RejectSharedDirectoryResult": { "type": "structure", "members": { "SharedDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the shared directory in the directory consumer account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#RemoteDomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+[.]?$" } }, "com.amazonaws.directoryservice#RemoteDomainNames": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#RemoteDomainName" } }, "com.amazonaws.directoryservice#RemoveIpRoutes": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RemoveIpRoutesRequest" }, "output": { "target": "com.amazonaws.directoryservice#RemoveIpRoutesResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Removes IP address blocks from a directory.

", "smithy.api#examples": [ { "title": "To remove IP routes", "documentation": "The following example removes IP address blocks from a specified directory.", "input": { "DirectoryId": "d-92654abfed", "CidrIps": [ "12.12.12.12/32" ] }, "output": {} } ] } }, "com.amazonaws.directoryservice#RemoveIpRoutesRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory from which you want to remove the IP addresses.

", "smithy.api#required": {} } }, "CidrIps": { "target": "com.amazonaws.directoryservice#CidrIps", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": [], "smithy.api#documentation": "

IP address blocks that you want to remove.

" } }, "CidrIpv6s": { "target": "com.amazonaws.directoryservice#CidrIpv6s", "traits": { "smithy.api#documentation": "

IPv6 address blocks that you want to remove.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RemoveIpRoutesResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#RemoveRegion": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RemoveRegionRequest" }, "output": { "target": "com.amazonaws.directoryservice#RemoveRegionResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Stops all replication and removes the domain controllers from the specified Region. You\n cannot remove the primary Region with this operation. Instead, use the\n DeleteDirectory API.

" } }, "com.amazonaws.directoryservice#RemoveRegionRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which you want to remove Region replication.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RemoveRegionResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#RemoveTagsFromResource": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RemoveTagsFromResourceRequest" }, "output": { "target": "com.amazonaws.directoryservice#RemoveTagsFromResourceResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Removes tags from a directory.

", "smithy.api#examples": [ { "title": "To remove tags from a directory", "documentation": "The following example removes a tag from a specified directory.", "input": { "ResourceId": "d-92654abfed", "TagKeys": [ "environment" ] }, "output": {} } ] } }, "com.amazonaws.directoryservice#RemoveTagsFromResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.directoryservice#ResourceId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory from which to remove the tag.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.directoryservice#TagKeys", "traits": { "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RemoveTagsFromResourceResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ReplicationScope": { "type": "enum", "members": { "Domain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Domain" } } } }, "com.amazonaws.directoryservice#RequestId": { "type": "string", "traits": { "smithy.api#documentation": "

The Amazon Web Services request identifier.

", "smithy.api#pattern": "^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$" } }, "com.amazonaws.directoryservice#ResetUserPassword": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ResetUserPasswordRequest" }, "output": { "target": "com.amazonaws.directoryservice#ResetUserPasswordResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidPasswordException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" }, { "target": "com.amazonaws.directoryservice#UserDoesNotExistException" } ], "traits": { "smithy.api#documentation": "

Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled\n users will become enabled and can be authenticated following the API call.

\n

You can reset the password for any user in your directory with the following\n exceptions:

\n " } }, "com.amazonaws.directoryservice#ResetUserPasswordRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.

", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.directoryservice#CustomerUserName", "traits": { "smithy.api#documentation": "

The user name of the user whose password will be reset.

", "smithy.api#required": {} } }, "NewPassword": { "target": "com.amazonaws.directoryservice#UserPassword", "traits": { "smithy.api#documentation": "

The new password that will be reset.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ResetUserPasswordResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ResourceId": { "type": "string", "traits": { "smithy.api#pattern": "^[d]-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#RestoreFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#RestoreFromSnapshotRequest" }, "output": { "target": "com.amazonaws.directoryservice#RestoreFromSnapshotResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Restores a directory using an existing directory snapshot.

\n

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

\n

This action returns as soon as the restore operation is initiated. You can monitor the\n progress of the restore operation by calling the DescribeDirectories operation with\n the directory identifier. When the DirectoryDescription.Stage value changes to\n Active, the restore operation is complete.

", "smithy.api#examples": [ { "title": "To restore a snapshot", "documentation": "The following example restores a directory using an existing directory snapshot.", "input": { "SnapshotId": "s-9267f6da4e" }, "output": {} } ] } }, "com.amazonaws.directoryservice#RestoreFromSnapshotRequest": { "type": "structure", "members": { "SnapshotId": { "target": "com.amazonaws.directoryservice#SnapshotId", "traits": { "smithy.api#documentation": "

The identifier of the snapshot to restore from.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An object representing the inputs for the RestoreFromSnapshot operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#RestoreFromSnapshotResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the RestoreFromSnapshot operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#SID": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[&\\w+-.@]+$" } }, "com.amazonaws.directoryservice#SchemaExtensionId": { "type": "string", "traits": { "smithy.api#pattern": "^e-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#SchemaExtensionInfo": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory to which the schema extension is applied.

" } }, "SchemaExtensionId": { "target": "com.amazonaws.directoryservice#SchemaExtensionId", "traits": { "smithy.api#documentation": "

The identifier of the schema extension.

" } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

A description of the schema extension.

" } }, "SchemaExtensionStatus": { "target": "com.amazonaws.directoryservice#SchemaExtensionStatus", "traits": { "smithy.api#documentation": "

The current status of the schema extension.

" } }, "SchemaExtensionStatusReason": { "target": "com.amazonaws.directoryservice#SchemaExtensionStatusReason", "traits": { "smithy.api#documentation": "

The reason for the SchemaExtensionStatus.

" } }, "StartDateTime": { "target": "com.amazonaws.directoryservice#StartDateTime", "traits": { "smithy.api#documentation": "

The date and time that the schema extension started being applied to the\n directory.

" } }, "EndDateTime": { "target": "com.amazonaws.directoryservice#EndDateTime", "traits": { "smithy.api#documentation": "

The date and time that the schema extension was completed.

" } } }, "traits": { "smithy.api#documentation": "

Information about a schema extension.

" } }, "com.amazonaws.directoryservice#SchemaExtensionStatus": { "type": "enum", "members": { "INITIALIZING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Initializing" } }, "CREATING_SNAPSHOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatingSnapshot" } }, "UPDATING_SCHEMA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdatingSchema" } }, "REPLICATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Replicating" } }, "CANCEL_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CancelInProgress" } }, "ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RollbackInProgress" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelled" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } } } }, "com.amazonaws.directoryservice#SchemaExtensionStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#SchemaExtensionsInfo": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#SchemaExtensionInfo" } }, "com.amazonaws.directoryservice#SecretArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=.@-]+-[a-zA-Z0-9]{6}$" } }, "com.amazonaws.directoryservice#SecurityGroupId": { "type": "string", "traits": { "smithy.api#pattern": "^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$" } }, "com.amazonaws.directoryservice#SecurityGroupIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#SecurityGroupId" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.directoryservice#SelectiveAuth": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.directoryservice#Server": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.directoryservice#Servers": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Server" } }, "com.amazonaws.directoryservice#ServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

An exception has occurred in Directory Service.

", "smithy.api#error": "server" } }, "com.amazonaws.directoryservice#Setting": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingName", "traits": { "smithy.api#documentation": "

The name of the directory setting. For example:

\n

\n TLS_1_0\n

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue", "traits": { "smithy.api#documentation": "

The value of the directory setting for which to retrieve information. For example, for\n TLS_1_0, the valid values are: Enable and\n Disable.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about the configurable settings for a directory.

" } }, "com.amazonaws.directoryservice#SettingEntries": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#SettingEntry" } }, "com.amazonaws.directoryservice#SettingEntry": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingType", "traits": { "smithy.api#documentation": "

The type, or category, of a directory setting. Similar settings have the same type. For\n example, Protocol, Cipher, or Certificate-Based\n Authentication.

" } }, "Name": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingName", "traits": { "smithy.api#documentation": "

The name of the directory setting. For example:

\n

\n TLS_1_0\n

" } }, "AllowedValues": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingAllowedValues", "traits": { "smithy.api#documentation": "

The valid range of values for the directory setting. These values depend on the\n DataType of your directory.

" } }, "AppliedValue": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue", "traits": { "smithy.api#documentation": "

The value of the directory setting that is applied to the directory.

" } }, "RequestedValue": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue", "traits": { "smithy.api#documentation": "

The value that was last requested for the directory setting.

" } }, "RequestStatus": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationStatus", "traits": { "smithy.api#documentation": "

The overall status of the request to update the directory setting request. If the\n directory setting is deployed in more than one region, and the request fails in any region,\n the overall status is Failed.

" } }, "RequestDetailedStatus": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestDetailedStatus", "traits": { "smithy.api#documentation": "

Details about the status of the request to update the directory setting. If the directory\n setting is deployed in more than one region, status is returned for the request in each region\n where the setting is deployed.

" } }, "RequestStatusMessage": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestStatusMessage", "traits": { "smithy.api#documentation": "

The last status message for the directory status request.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the directory setting was last updated.

" } }, "LastRequestedDateTime": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastRequestedDateTime", "traits": { "smithy.api#documentation": "

The date and time when the request to update a directory setting was last\n submitted.

" } }, "DataType": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingDataType", "traits": { "smithy.api#documentation": "

The data type of a directory setting. This is used to define the\n AllowedValues of a setting. For example a data type can be\n Boolean, DurationInSeconds, or Enum.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the specified configurable setting for a directory.

" } }, "com.amazonaws.directoryservice#Settings": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Setting" } }, "com.amazonaws.directoryservice#ShareDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#ShareDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#ShareDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryAlreadySharedException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#InvalidTargetException" }, { "target": "com.amazonaws.directoryservice#OrganizationsException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#ShareLimitExceededException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory\n owner) with another Amazon Web Services account (directory consumer). With this operation you can use your\n directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.

\n

When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the\n directory consumer account. This shared directory contains the metadata to provide access to\n the directory within the directory owner account. The shared directory is visible in all VPCs\n in the directory consumer account.

\n

The ShareMethod parameter determines whether the specified directory can be\n shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS).\n It also determines whether you can share the directory with any other Amazon Web Services account either\n inside or outside of the organization (HANDSHAKE).

\n

The ShareNotes parameter is only used when HANDSHAKE is called,\n which sends a directory sharing request to the directory consumer.

" } }, "com.amazonaws.directoryservice#ShareDirectoryRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the Managed Microsoft AD directory that you want to share with other\n Amazon Web Services accounts.

", "smithy.api#required": {} } }, "ShareNotes": { "target": "com.amazonaws.directoryservice#Notes", "traits": { "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" } }, "ShareTarget": { "target": "com.amazonaws.directoryservice#ShareTarget", "traits": { "smithy.api#documentation": "

Identifier for the directory consumer account with whom the directory is to be\n shared.

", "smithy.api#required": {} } }, "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account\n by sending a directory sharing request (HANDSHAKE).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#ShareDirectoryResult": { "type": "structure", "members": { "SharedDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory that is stored in the directory consumer account that is\n shared from the specified directory (DirectoryId).

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#ShareLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The maximum number of Amazon Web Services accounts that you can share with this directory has been\n reached.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#ShareMethod": { "type": "enum", "members": { "ORGANIZATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATIONS" } }, "HANDSHAKE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HANDSHAKE" } } } }, "com.amazonaws.directoryservice#ShareStatus": { "type": "enum", "members": { "SHARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Shared" } }, "PENDING_ACCEPTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingAcceptance" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Rejected" } }, "REJECTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Rejecting" } }, "REJECT_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RejectFailed" } }, "SHARING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Sharing" } }, "SHARE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ShareFailed" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleted" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleting" } } } }, "com.amazonaws.directoryservice#ShareTarget": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.directoryservice#TargetId", "traits": { "smithy.api#documentation": "

Identifier of the directory consumer account.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#TargetType", "traits": { "smithy.api#documentation": "

Type of identifier to be used in the Id field.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifier that contains details about the directory consumer account.

" } }, "com.amazonaws.directoryservice#SharedDirectories": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#SharedDirectory" } }, "com.amazonaws.directoryservice#SharedDirectory": { "type": "structure", "members": { "OwnerAccountId": { "target": "com.amazonaws.directoryservice#CustomerId", "traits": { "smithy.api#documentation": "

Identifier of the directory owner account, which contains the directory that has been\n shared to the consumer account.

" } }, "OwnerDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory in the directory owner account.

" } }, "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account\n by sending a shared directory request (HANDSHAKE).

" } }, "SharedAccountId": { "target": "com.amazonaws.directoryservice#CustomerId", "traits": { "smithy.api#documentation": "

Identifier of the directory consumer account that has access to the shared directory\n (OwnerDirectoryId) in the directory owner account.

" } }, "SharedDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the shared directory in the directory consumer account. This identifier is\n different for each directory owner account.

" } }, "ShareStatus": { "target": "com.amazonaws.directoryservice#ShareStatus", "traits": { "smithy.api#documentation": "

Current directory status of the shared Managed Microsoft AD directory.

" } }, "ShareNotes": { "target": "com.amazonaws.directoryservice#Notes", "traits": { "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" } }, "CreatedDateTime": { "target": "com.amazonaws.directoryservice#CreatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the shared directory was created.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the shared directory was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Details about the shared directory in the directory owner account for which the share\n request in the directory consumer account has been accepted.

" } }, "com.amazonaws.directoryservice#Snapshot": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory identifier.

" } }, "SnapshotId": { "target": "com.amazonaws.directoryservice#SnapshotId", "traits": { "smithy.api#documentation": "

The snapshot identifier.

" } }, "Type": { "target": "com.amazonaws.directoryservice#SnapshotType", "traits": { "smithy.api#documentation": "

The snapshot type.

" } }, "Name": { "target": "com.amazonaws.directoryservice#SnapshotName", "traits": { "smithy.api#documentation": "

The descriptive name of the snapshot.

" } }, "Status": { "target": "com.amazonaws.directoryservice#SnapshotStatus", "traits": { "smithy.api#documentation": "

The snapshot status.

" } }, "StartTime": { "target": "com.amazonaws.directoryservice#StartTime", "traits": { "smithy.api#documentation": "

The date and time that the snapshot was taken.

" } } }, "traits": { "smithy.api#documentation": "

Describes a directory snapshot.

" } }, "com.amazonaws.directoryservice#SnapshotId": { "type": "string", "traits": { "smithy.api#pattern": "^s-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#SnapshotIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#SnapshotId" }, "traits": { "smithy.api#documentation": "

A list of directory snapshot identifiers.

" } }, "com.amazonaws.directoryservice#SnapshotLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The maximum number of manual snapshots for the directory has been reached. You can\n use the GetSnapshotLimits operation to determine the snapshot limits\n for a directory.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#SnapshotLimits": { "type": "structure", "members": { "ManualSnapshotsLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of manual snapshots allowed.

" } }, "ManualSnapshotsCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The current number of manual snapshots of the directory.

" } }, "ManualSnapshotsLimitReached": { "target": "com.amazonaws.directoryservice#ManualSnapshotsLimitReached", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates if the manual snapshot limit has been reached.

" } } }, "traits": { "smithy.api#documentation": "

Contains manual snapshot limit information for a directory.

" } }, "com.amazonaws.directoryservice#SnapshotName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" } }, "com.amazonaws.directoryservice#SnapshotStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Creating" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.directoryservice#SnapshotType": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Auto" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Manual" } } } }, "com.amazonaws.directoryservice#Snapshots": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Snapshot" }, "traits": { "smithy.api#documentation": "

A list of descriptions of directory snapshots.

" } }, "com.amazonaws.directoryservice#SsoEnabled": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#StageReason": { "type": "string" }, "com.amazonaws.directoryservice#StartADAssessment": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#StartADAssessmentRequest" }, "output": { "target": "com.amazonaws.directoryservice#StartADAssessmentResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ADAssessmentLimitExceededException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Initiates a directory assessment to validate your self-managed AD environment for\n hybrid domain join. The assessment checks compatibility and connectivity of the\n self-managed AD environment.

\n

A directory assessment is automatically created when you create a hybrid directory.\n There are two types of assessments: CUSTOMER and SYSTEM. Your\n Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

\n

The assessment process typically takes 30 minutes or more to complete. The assessment\n process is asynchronous and you can monitor it with\n DescribeADAssessment.

\n

The InstanceIds must have a one-to-one correspondence with\n CustomerDnsIps, meaning that if the IP address for instance i-10243410\n is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the\n input arrays must maintain the same order relationship, either [10.24.34.100,\n 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100]\n paired with [i-10243420, i-10243410].

\n

Note: You must provide exactly one DirectoryId or\n AssessmentConfiguration.

" } }, "com.amazonaws.directoryservice#StartADAssessmentRequest": { "type": "structure", "members": { "AssessmentConfiguration": { "target": "com.amazonaws.directoryservice#AssessmentConfiguration", "traits": { "smithy.api#documentation": "

Configuration parameters for the directory assessment, including DNS server\n information, domain name, Amazon VPC subnet, and Amazon Web Services System Manager managed node\n details.

" } }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to perform the assessment. This should be an\n existing directory. If the assessment is not for an existing directory, this parameter\n should be omitted.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#StartADAssessmentResult": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The unique identifier of the newly started directory assessment. Use this identifier\n to monitor assessment progress and retrieve results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#StartDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#StartSchemaExtension": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#StartSchemaExtensionRequest" }, "output": { "target": "com.amazonaws.directoryservice#StartSchemaExtensionResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#SnapshotLimitExceededException" } ], "traits": { "smithy.api#documentation": "

Applies a schema extension to a Microsoft AD directory.

", "smithy.api#examples": [ { "title": "To start a schema extension", "documentation": "The following example applies a schema extension to a specified Microsoft AD directory.", "input": { "CreateSnapshotBeforeSchemaExtension": true, "DirectoryId": "d-92654abfed", "LdifContent": "dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com\nchangetype: modify\nadd: mayContain\nmayContain: drink\n-\n\nDN:\nchangetype: modify\nreplace: schemaupdatenow\nschemaupdatenow: 1\n-", "Description": "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file." }, "output": { "SchemaExtensionId": "e-926731dc50" } } ] } }, "com.amazonaws.directoryservice#StartSchemaExtensionRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which the schema extension will be applied\n to.

", "smithy.api#required": {} } }, "CreateSnapshotBeforeSchemaExtension": { "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeSchemaExtension", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

If true, creates a snapshot of the directory before applying the schema\n extension.

", "smithy.api#required": {} } }, "LdifContent": { "target": "com.amazonaws.directoryservice#LdifContent", "traits": { "smithy.api#documentation": "

The LDIF file represented as a string. To construct the LdifContent string, precede\n each line as it would be formatted in an ldif file with \\n. See the example request below for\n more details. The file size can be no larger than 1MB.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

A description of the schema extension.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#StartSchemaExtensionResult": { "type": "structure", "members": { "SchemaExtensionId": { "target": "com.amazonaws.directoryservice#SchemaExtensionId", "traits": { "smithy.api#documentation": "

The identifier of the schema extension that will be applied.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#StartTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#StateLastUpdatedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#SubnetId": { "type": "string", "traits": { "smithy.api#pattern": "^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$" } }, "com.amazonaws.directoryservice#SubnetIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#SubnetId" } }, "com.amazonaws.directoryservice#SubscriptionCreatedDateTime": { "type": "timestamp" }, "com.amazonaws.directoryservice#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.directoryservice#TagKey", "traits": { "smithy.api#documentation": "

Required name of the tag. The string value can be Unicode characters and cannot be\n prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits,\n white-space, '_', '.', '/', '=', '+', '-', ':', '@'(Java regex:\n \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.directoryservice#TagValue", "traits": { "smithy.api#documentation": "

The optional value of the tag. The string value can be Unicode characters. The string\n can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-', ':', '@'\n (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Metadata assigned to a directory consisting of a key-value pair.

" } }, "com.amazonaws.directoryservice#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.directoryservice#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#TagKey" } }, "com.amazonaws.directoryservice#TagLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The maximum allowed number of tags was exceeded.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.directoryservice#Tags": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Tag" } }, "com.amazonaws.directoryservice#TargetId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.directoryservice#TargetType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } } } }, "com.amazonaws.directoryservice#TopicArn": { "type": "string" }, "com.amazonaws.directoryservice#TopicName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, "com.amazonaws.directoryservice#TopicNames": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#TopicName" } }, "com.amazonaws.directoryservice#TopicStatus": { "type": "enum", "members": { "REGISTERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Registered" } }, "TOPIC_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Topic not found" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleted" } } } }, "com.amazonaws.directoryservice#Trust": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The Directory ID of the Amazon Web Services directory involved in the trust relationship.

" } }, "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

The unique ID of the trust relationship.

" } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust\n relationship.

" } }, "TrustType": { "target": "com.amazonaws.directoryservice#TrustType", "traits": { "smithy.api#documentation": "

The trust relationship type. Forest is the default.

" } }, "TrustDirection": { "target": "com.amazonaws.directoryservice#TrustDirection", "traits": { "smithy.api#documentation": "

The trust relationship direction.

" } }, "TrustState": { "target": "com.amazonaws.directoryservice#TrustState", "traits": { "smithy.api#documentation": "

The trust relationship state.

" } }, "CreatedDateTime": { "target": "com.amazonaws.directoryservice#CreatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the trust relationship was created.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the trust relationship was last updated.

" } }, "StateLastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#StateLastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The date and time that the TrustState was last updated.

" } }, "TrustStateReason": { "target": "com.amazonaws.directoryservice#TrustStateReason", "traits": { "smithy.api#documentation": "

The reason for the TrustState.

" } }, "SelectiveAuth": { "target": "com.amazonaws.directoryservice#SelectiveAuth", "traits": { "smithy.api#documentation": "

Current state of selective authentication for the trust.

" } } }, "traits": { "smithy.api#documentation": "

Describes a trust relationship between an Managed Microsoft AD directory and an external\n domain.

" } }, "com.amazonaws.directoryservice#TrustDirection": { "type": "enum", "members": { "ONE_WAY_OUTGOING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "One-Way: Outgoing" } }, "ONE_WAY_INCOMING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "One-Way: Incoming" } }, "TWO_WAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Two-Way" } } } }, "com.amazonaws.directoryservice#TrustId": { "type": "string", "traits": { "smithy.api#pattern": "^t-[0-9a-f]{10}$" } }, "com.amazonaws.directoryservice#TrustIds": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#TrustId" } }, "com.amazonaws.directoryservice#TrustPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(\\p{LD}|\\p{Punct}| )+$", "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#TrustState": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Creating" } }, "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Created" } }, "VERIFYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Verifying" } }, "VERIFY_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VerifyFailed" } }, "VERIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Verified" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updating" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateFailed" } }, "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updated" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleting" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deleted" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.directoryservice#TrustStateReason": { "type": "string" }, "com.amazonaws.directoryservice#TrustType": { "type": "enum", "members": { "FOREST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Forest" } }, "EXTERNAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "External" } } } }, "com.amazonaws.directoryservice#Trusts": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#Trust" } }, "com.amazonaws.directoryservice#UnshareDirectory": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UnshareDirectoryRequest" }, "output": { "target": "com.amazonaws.directoryservice#UnshareDirectoryResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryNotSharedException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidTargetException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Stops the directory sharing between the directory owner and consumer accounts.

" } }, "com.amazonaws.directoryservice#UnshareDirectoryRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Managed Microsoft AD directory that you want to stop sharing.

", "smithy.api#required": {} } }, "UnshareTarget": { "target": "com.amazonaws.directoryservice#UnshareTarget", "traits": { "smithy.api#documentation": "

Identifier for the directory consumer account with whom the directory has to be\n unshared.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UnshareDirectoryResult": { "type": "structure", "members": { "SharedDirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory stored in the directory consumer account that is to be\n unshared from the specified directory (DirectoryId).

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UnshareTarget": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.directoryservice#TargetId", "traits": { "smithy.api#documentation": "

Identifier of the directory consumer account.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.directoryservice#TargetType", "traits": { "smithy.api#documentation": "

Type of identifier to be used in the Id field.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifier that contains details about the directory consumer account with whom the\n directory is being unshared.

" } }, "com.amazonaws.directoryservice#UnsupportedOperationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The operation is not supported.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#UnsupportedSettingsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The specified directory setting is not supported.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#UpdateActivities": { "type": "list", "member": { "target": "com.amazonaws.directoryservice#UpdateInfoEntry" } }, "com.amazonaws.directoryservice#UpdateConditionalForwarder": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateConditionalForwarderRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateConditionalForwarderResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Updates a conditional forwarder that has been set up for your Amazon Web Services\n directory.

", "smithy.api#examples": [ { "title": "To update a conditional forwarder", "documentation": "The following example updates a conditional forwarder for a specified directory.", "input": { "DirectoryId": "d-92654abfed", "RemoteDomainName": "sales.example.com", "DnsIpAddrs": [ "172.168.101.11" ] }, "output": {} } ] } }, "com.amazonaws.directoryservice#UpdateConditionalForwarderRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory ID of the Amazon Web Services directory for which to update the conditional\n forwarder.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you will set up\n a trust relationship.

", "smithy.api#required": {} } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": [], "smithy.api#documentation": "

The updated IP addresses of the remote DNS server associated with the conditional\n forwarder.

" } }, "DnsIpv6Addrs": { "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", "traits": { "smithy.api#documentation": "

The updated IPv6 addresses of the remote DNS server associated with the conditional\n forwarder.

" } } }, "traits": { "smithy.api#documentation": "

Updates a conditional forwarder.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateConditionalForwarderResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The result of an UpdateConditionalForwarder request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateDirectorySetup": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateDirectorySetupRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateDirectorySetupResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#AccessDeniedException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryInDesiredStateException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#SnapshotLimitExceededException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Updates directory configuration for the specified update type.

" } }, "com.amazonaws.directoryservice#UpdateDirectorySetupRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory to update.

", "smithy.api#required": {} } }, "UpdateType": { "target": "com.amazonaws.directoryservice#UpdateType", "traits": { "smithy.api#documentation": "

The type of update to perform on the directory.

", "smithy.api#required": {} } }, "OSUpdateSettings": { "target": "com.amazonaws.directoryservice#OSUpdateSettings", "traits": { "smithy.api#documentation": "

Operating system configuration to apply during the directory update operation.

" } }, "DirectorySizeUpdateSettings": { "target": "com.amazonaws.directoryservice#DirectorySizeUpdateSettings", "traits": { "smithy.api#documentation": "

Directory size configuration to apply during the update operation.

" } }, "NetworkUpdateSettings": { "target": "com.amazonaws.directoryservice#NetworkUpdateSettings", "traits": { "smithy.api#documentation": "

Network configuration to apply during the directory update operation.

" } }, "CreateSnapshotBeforeUpdate": { "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeUpdate", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to create a directory snapshot before performing the update.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateDirectorySetupResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateHybridAD": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateHybridADRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateHybridADResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ADAssessmentLimitExceededException" }, { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Updates the configuration of an existing hybrid directory. You can recover hybrid\n directory administrator account or modify self-managed instance settings.

\n

Updates are applied asynchronously. Use DescribeHybridADUpdate to\n monitor the progress of configuration changes.

\n

The InstanceIds must have a one-to-one correspondence with\n CustomerDnsIps, meaning that if the IP address for instance i-10243410\n is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the\n input arrays must maintain the same order relationship, either [10.24.34.100,\n 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100]\n paired with [i-10243420, i-10243410].

\n \n

You must provide at least one update to UpdateHybridADRequest$HybridAdministratorAccountUpdate or UpdateHybridADRequest$SelfManagedInstancesSettings.

\n
" } }, "com.amazonaws.directoryservice#UpdateHybridADRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the hybrid directory to update.

", "smithy.api#required": {} } }, "HybridAdministratorAccountUpdate": { "target": "com.amazonaws.directoryservice#HybridAdministratorAccountUpdate", "traits": { "smithy.api#documentation": "

We create a hybrid directory administrator account when we create a hybrid directory.\n Use HybridAdministratorAccountUpdate to recover the hybrid directory\n administrator account if you have deleted it.

\n

To recover your hybrid directory administrator account, we need temporary access to a\n user in your self-managed AD with administrator permissions in the form of a secret from\n Amazon Web Services Secrets Manager. We use these credentials once during recovery and don't store them.

\n

If your hybrid directory administrator account exists, then you don\u2019t need to use\n HybridAdministratorAccountUpdate, even if you have updated your\n self-managed AD administrator user.

" } }, "SelfManagedInstancesSettings": { "target": "com.amazonaws.directoryservice#HybridCustomerInstancesSettings", "traits": { "smithy.api#documentation": "

Updates to the self-managed AD configuration, including DNS server IP addresses and\n Amazon Web Services System Manager managed node identifiers.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateHybridADResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the updated hybrid directory.

" } }, "AssessmentId": { "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { "smithy.api#documentation": "

The identifier of the assessment performed to validate the update configuration. This\n assessment ensures the updated settings are compatible with your environment.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateInfoEntry": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { "smithy.api#documentation": "

The name of the Region.

" } }, "Status": { "target": "com.amazonaws.directoryservice#UpdateStatus", "traits": { "smithy.api#documentation": "

The status of the update performed on the directory.

" } }, "StatusReason": { "target": "com.amazonaws.directoryservice#UpdateStatusReason", "traits": { "smithy.api#documentation": "

The reason for the current status of the update type activity.

" } }, "InitiatedBy": { "target": "com.amazonaws.directoryservice#InitiatedBy", "traits": { "smithy.api#documentation": "

This specifies if the update was initiated by the customer or by the service team.\n

" } }, "NewValue": { "target": "com.amazonaws.directoryservice#UpdateValue", "traits": { "smithy.api#documentation": "

The new value of the target setting.

" } }, "PreviousValue": { "target": "com.amazonaws.directoryservice#UpdateValue", "traits": { "smithy.api#documentation": "

The old value of the target setting.

" } }, "StartTime": { "target": "com.amazonaws.directoryservice#StartDateTime", "traits": { "smithy.api#documentation": "

The start time of the UpdateDirectorySetup for the particular type.

" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { "smithy.api#documentation": "

The last updated date and time of a particular directory setting.

" } } }, "traits": { "smithy.api#documentation": "

An entry of update information related to a requested update type.

" } }, "com.amazonaws.directoryservice#UpdateNumberOfDomainControllers": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateNumberOfDomainControllersRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateNumberOfDomainControllersResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#DomainControllerLimitExceededException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Adds or removes domain controllers to or from the directory. Based on the difference\n between current value and new value (provided through this API call), domain controllers will\n be added or removed. It may take up to 45 minutes for any new domain controllers to become\n fully active once the requested number of domain controllers is updated. During this time, you\n cannot make another update request.

" } }, "com.amazonaws.directoryservice#UpdateNumberOfDomainControllersRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier of the directory to which the domain controllers will be added or\n removed.

", "smithy.api#required": {} } }, "DesiredNumber": { "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", "traits": { "smithy.api#documentation": "

The number of domain controllers desired in the directory.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateNumberOfDomainControllersResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateRadius": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateRadiusRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateRadiusResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Updates the Remote Authentication Dial In User Service (RADIUS) server information for\n an AD Connector or Microsoft AD directory.

", "smithy.api#examples": [ { "title": "To update Radius", "documentation": "The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD Connector directory.", "input": { "DirectoryId": "d-92654abfed", "RadiusSettings": { "DisplayLabel": "MyRadius", "UseSameUsername": true, "RadiusTimeout": 1, "AuthenticationProtocol": "PAP", "RadiusPort": 1027, "RadiusRetries": 1, "SharedSecret": "12345678", "RadiusServers": [ "172.168.101.113" ] } }, "output": {} } ] } }, "com.amazonaws.directoryservice#UpdateRadiusRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to update the RADIUS server\n information.

", "smithy.api#required": {} } }, "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS\n server.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the inputs for the UpdateRadius operation.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateRadiusResult": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Contains the results of the UpdateRadius operation.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#UpdateSettings": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateSettingsRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateSettingsResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservice#IncompatibleSettingsException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" }, { "target": "com.amazonaws.directoryservice#UnsupportedSettingsException" } ], "traits": { "smithy.api#documentation": "

Updates the configurable settings for the specified directory.

" } }, "com.amazonaws.directoryservice#UpdateSettingsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to update settings.

", "smithy.api#required": {} } }, "Settings": { "target": "com.amazonaws.directoryservice#Settings", "traits": { "smithy.api#documentation": "

The list of Setting objects.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateSettingsResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateStatus": { "type": "enum", "members": { "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updated" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Updating" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateFailed" } } } }, "com.amazonaws.directoryservice#UpdateStatusReason": { "type": "string" }, "com.amazonaws.directoryservice#UpdateTrust": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#UpdateTrustRequest" }, "output": { "target": "com.amazonaws.directoryservice#UpdateTrustResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" } ], "traits": { "smithy.api#documentation": "

Updates the trust that has been set up between your Managed Microsoft AD directory and an\n self-managed Active Directory.

" } }, "com.amazonaws.directoryservice#UpdateTrustRequest": { "type": "structure", "members": { "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

Identifier of the trust relationship.

", "smithy.api#required": {} } }, "SelectiveAuth": { "target": "com.amazonaws.directoryservice#SelectiveAuth", "traits": { "smithy.api#documentation": "

Updates selective authentication for the trust.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservice#UpdateTrustResult": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" }, "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

Identifier of the trust relationship.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservice#UpdateType": { "type": "enum", "members": { "OS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OS" } }, "NETWORK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NETWORK" } }, "SIZE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIZE" } } } }, "com.amazonaws.directoryservice#UpdateValue": { "type": "structure", "members": { "OSUpdateSettings": { "target": "com.amazonaws.directoryservice#OSUpdateSettings", "traits": { "smithy.api#documentation": "

The OS update related settings.

" } } }, "traits": { "smithy.api#documentation": "

The value for a given type of UpdateSettings.

" } }, "com.amazonaws.directoryservice#UseSameUsername": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.directoryservice#UserDoesNotExistException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { "smithy.api#documentation": "

The user provided a username that does not exist in your directory.

", "smithy.api#error": "client" } }, "com.amazonaws.directoryservice#UserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" } }, "com.amazonaws.directoryservice#UserPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservice#VerifyTrust": { "type": "operation", "input": { "target": "com.amazonaws.directoryservice#VerifyTrustRequest" }, "output": { "target": "com.amazonaws.directoryservice#VerifyTrustResult" }, "errors": [ { "target": "com.amazonaws.directoryservice#ClientException" }, { "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" }, { "target": "com.amazonaws.directoryservice#InvalidParameterException" }, { "target": "com.amazonaws.directoryservice#ServiceException" }, { "target": "com.amazonaws.directoryservice#UnsupportedOperationException" } ], "traits": { "smithy.api#documentation": "

Directory Service for Microsoft Active Directory allows you to configure and verify trust\n relationships.

\n

This action verifies a trust relationship between your Managed Microsoft AD directory and an\n external domain.

", "smithy.api#examples": [ { "title": "To verify a trust", "documentation": "The following example verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.", "input": { "TrustId": "t-9267353df0" }, "output": { "TrustId": "t-9267353df0" } } ] } }, "com.amazonaws.directoryservice#VerifyTrustRequest": { "type": "structure", "members": { "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

The unique Trust ID of the trust relationship to verify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Initiates the verification of an existing trust relationship between an Managed Microsoft AD\n directory and an external domain.

", "smithy.api#input": {} } }, "com.amazonaws.directoryservice#VerifyTrustResult": { "type": "structure", "members": { "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

The unique Trust ID of the trust relationship that was verified.

" } } }, "traits": { "smithy.api#documentation": "

Result of a VerifyTrust request.

", "smithy.api#output": {} } }, "com.amazonaws.directoryservice#VpcId": { "type": "string", "traits": { "smithy.api#pattern": "^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$" } } } }