{ "smithy": "2.0", "shapes": { "com.amazonaws.directoryservicedata#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservicedata#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.directoryservicedata#AccessDeniedReason", "traits": { "smithy.api#documentation": "
Reason the request was unauthorized.
" } } }, "traits": { "smithy.api#documentation": " You don't have permission to perform the request or access the directory. It can also\n occur when the DirectoryId doesn't exist or the user, member, or group might be\n outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action.\n Review the directory information in the request, and make sure that the object isn't outside\n of your OU.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.directoryservicedata#AccessDeniedReason": { "type": "enum", "members": { "IAM_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IAM_AUTH" } }, "DIRECTORY_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_AUTH" } }, "DATA_DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DATA_DISABLED" } } } }, "com.amazonaws.directoryservicedata#AddGroupMember": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#AddGroupMemberRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#AddGroupMemberResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds an existing user, group, or computer as a group member.
", "smithy.api#examples": [ { "title": "To add a member to the Marketing group", "documentation": "The following command adds an existing user to the Marketing group in the europe.example.com domain.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "GroupName": "Marketing", "MemberName": "Pat Candella", "MemberRealm": "europe.example.com" }, "output": {} } ], "smithy.api#http": { "uri": "/GroupMemberships/AddGroupMember", "method": "POST" } } }, "com.amazonaws.directoryservicedata#AddGroupMemberRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "GroupName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "MemberName": { "target": "com.amazonaws.directoryservicedata#MemberName", "traits": { "smithy.api#documentation": " The SAMAccountName of the user, group, or computer to add as a group member.\n
The domain name that's associated with the group member. This parameter is required only\n when adding a member outside of your Managed Microsoft AD domain to a group inside of your\n Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain.
\nThis parameter is case insensitive.
\nA unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nIndicates that the attribute type value is a string. For example:
\n\n \"S\": \"S Group\"\n
Indicates that the attribute type value is a number. For example:
\n\n \"N\": \"16\"\n
Indicates that the attribute type value is a boolean. For example:
\n\n \"BOOL\": true\n
Indicates that the attribute type value is a string set. For example:
\n\n \"SS\": [\"sample_service_class/host.sample.com:1234/sample_service_name_1\",\n \"sample_service_class/host.sample.com:1234/sample_service_name_2\"]\n
The data type for an attribute. Each attribute value is described as a name-value pair.\n The name is the AD schema name, and the value is the data itself. For a list of supported\n attributes, see Directory Service Data Attributes.\n
" } }, "com.amazonaws.directoryservicedata#Attributes": { "type": "map", "key": { "target": "com.amazonaws.directoryservicedata#LdapDisplayName" }, "value": { "target": "com.amazonaws.directoryservicedata#AttributeValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.directoryservicedata#BooleanAttributeValue": { "type": "boolean", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x00-\\x7F]+$" } }, "com.amazonaws.directoryservicedata#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservicedata#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "This error will occur when you try to create a resource that conflicts with an existing\n object. It can also occur when adding a member to a group that the member is already\n in.
\nThis error can be caused by a request sent within the 8-hour idempotency window with the\n same client token but different input parameters. Client tokens should not be re-used across\n different requests. After 8 hours, any request with the same client token is treated as a new\n request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.directoryservicedata#CreateGroup": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#CreateGroupRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#CreateGroupResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a new group.
", "smithy.api#examples": [ { "title": "To create a group", "documentation": "The following command creates a distribution list group named AcctngMail.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "GroupScope": "DomainLocal", "GroupType": "Distribution", "OtherAttributes": { "displayName": { "S": "Acctng-mailing-list" }, "description": { "S": "Accounting dept mailing list" } }, "SAMAccountName": "AcctngMail" }, "output": { "DirectoryId": "d-12233abcde", "SAMAccountName": "AcctngMail", "SID": "S-1-5-33-123" } } ], "smithy.api#http": { "uri": "/Groups/CreateGroup", "method": "POST" } } }, "com.amazonaws.directoryservicedata#CreateGroupRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "GroupType": { "target": "com.amazonaws.directoryservicedata#GroupType", "traits": { "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" } }, "GroupScope": { "target": "com.amazonaws.directoryservicedata#GroupScope", "traits": { "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security group scope.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "An expression that defines one or more attributes with the data type and value of each\n attribute.
" } }, "ClientToken": { "target": "com.amazonaws.directoryservicedata#ClientToken", "traits": { "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe identifier (ID) of the directory that's associated with the group.
" } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
" } }, "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#CreateUser": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#CreateUserRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#CreateUserResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a new user.
", "smithy.api#examples": [ { "title": "To create a new user in the directory", "documentation": "The following command", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "EmailAddress": "pcandella@exampledomain.com", "GivenName": "Pat Candella", "OtherAttributes": { "department": { "S": "HR" }, "homePhone": { "S": "212-555-0100" } }, "SAMAccountName": "pcandella", "Surname": "Candella" }, "output": { "DirectoryId": "d-12233abcde", "SAMAccountName": "pcandella", "SID": "S-1-5-99-789" } } ], "smithy.api#http": { "uri": "/Users/CreateUser", "method": "POST" } } }, "com.amazonaws.directoryservicedata#CreateUserRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that\u2019s associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "EmailAddress": { "target": "com.amazonaws.directoryservicedata#EmailAddress", "traits": { "smithy.api#documentation": "The email address of the user.
" } }, "GivenName": { "target": "com.amazonaws.directoryservicedata#GivenName", "traits": { "smithy.api#documentation": "The first name of the user.
" } }, "Surname": { "target": "com.amazonaws.directoryservicedata#Surname", "traits": { "smithy.api#documentation": "The last name of the user.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "An expression that defines one or more attribute names with the data type and value of\n each attribute. A key is an attribute name, and the value is a list of maps. For a list of\n supported attributes, see Directory Service Data Attributes.
\nAttribute names are case insensitive.
\nA unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe identifier (ID) of the directory where the address block is added.
" } }, "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the user.
" } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#DeleteGroup": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#DeleteGroupRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#DeleteGroupResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a group.
", "smithy.api#examples": [ { "title": "To delete a group", "documentation": "The following command deletes the marketing group from the specified directory.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "SAMAccountName": "marketing" }, "output": {} } ], "smithy.api#http": { "uri": "/Groups/DeleteGroup", "method": "POST" } } }, "com.amazonaws.directoryservicedata#DeleteGroupRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.directoryservicedata#ClientToken", "traits": { "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nDeletes a user.
", "smithy.api#examples": [ { "title": "To delete a user", "documentation": "The following command deletes a group from the directory.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "SAMAccountName": "pcandella" }, "output": {} } ], "smithy.api#http": { "uri": "/Users/DeleteUser", "method": "POST" } } }, "com.amazonaws.directoryservicedata#DeleteUserRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.directoryservicedata#ClientToken", "traits": { "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nReturns information about a specific group.
", "smithy.api#examples": [ { "title": "To return the attributes of a group", "documentation": "The following command returns the mapped attributes for a group along with the display name, description, and GUID for the group.", "input": { "DirectoryId": "d-12233abcde", "OtherAttributes": [ "displayName", "description", "objectGUID" ], "Realm": "example.domain.com", "SAMAccountName": "DevOpsMail" }, "output": { "DirectoryId": "d-12233abcde", "DistinguishedName": "DevOpsmail", "GroupScope": "Global", "GroupType": "Distribution", "OtherAttributes": { "displayName": { "S": "DevOps mailing list" }, "description": { "S": "A group for DevOps email." }, "objectGUID": { "S": "123456789" } }, "SAMAccountName": "DevOpsMail", "SID": "S-1-5-55-678" } } ], "smithy.api#http": { "uri": "/Groups/DescribeGroup", "method": "POST" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "DescribeGroupFailure", "params": { "DirectoryId": "d-1111111111", "SAMAccountName": "test-group" }, "expect": { "failure": { "errorId": "com.amazonaws.directoryservicedata#AccessDeniedException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.directoryservicedata#DescribeGroupRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The Identifier (ID) of the directory associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive.
\nThe name of the group.
", "smithy.api#required": {} } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#LdapDisplayNameList", "traits": { "smithy.api#documentation": "One or more attributes to be returned for the group. For a list of supported attributes,\n see Directory Service Data Attributes.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#DescribeGroupResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the group.
" } }, "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the group.
" } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
" } }, "DistinguishedName": { "target": "com.amazonaws.directoryservicedata#DistinguishedName", "traits": { "smithy.api#documentation": "The distinguished name of the object.
" } }, "GroupType": { "target": "com.amazonaws.directoryservicedata#GroupType", "traits": { "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" } }, "GroupScope": { "target": "com.amazonaws.directoryservicedata#GroupScope", "traits": { "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "The attribute values that are returned for the attribute names that are included in the\n request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#DescribeUser": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#DescribeUserRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#DescribeUserResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a specific user.
", "smithy.api#examples": [ { "title": "To return the attributes of a user", "documentation": "The following command returns the mapped attributes for a user along with the department, manager, IP phone, and date the user last set a password.", "input": { "DirectoryId": "d-12233abcde", "OtherAttributes": [ "department", "manager", "ipPhone", "pwdLastSet" ], "Realm": "examplecorp.com", "SAMAccountName": "twhitlock" }, "output": { "DirectoryId": "d-12233abcde", "DistinguishedName": "Terry Whitlock", "EmailAddress": "terry.whitlock@examplecorp.com", "Enabled": true, "GivenName": "Terry Whitlock", "OtherAttributes": { "department": { "S": "communications" }, "manager": { "S": "OU=Users,DC=mmajors" }, "ipPhone": { "S": "111.111.111.111" }, "pwdLastSet": { "N": 0 } }, "SAMAccountName": "twhitlock", "SID": "123-456-7890", "Surname": "Whitlock", "UserPrincipalName": "terry.whitlock" } } ], "smithy.api#http": { "uri": "/Users/DescribeUser", "method": "POST" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "DescribeUserFailure", "params": { "DirectoryId": "d-1111111111", "SAMAccountName": "test-user" }, "expect": { "failure": { "errorId": "com.amazonaws.directoryservicedata#AccessDeniedException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.directoryservicedata#DescribeUserRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#LdapDisplayNameList", "traits": { "smithy.api#documentation": "One or more attribute names to be returned for the user. A key is an attribute name, and\n the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the user.
\nThis parameter is optional, so you can return users outside your Managed Microsoft AD domain.\n When no value is defined, only your Managed Microsoft AD users are returned.
\nThis value is case insensitive.
\nThe identifier (ID) of the directory that's associated with the user.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the user.
" } }, "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the user.
" } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
" } }, "DistinguishedName": { "target": "com.amazonaws.directoryservicedata#DistinguishedName", "traits": { "smithy.api#documentation": "The distinguished name of the object.
" } }, "UserPrincipalName": { "target": "com.amazonaws.directoryservicedata#UserPrincipalName", "traits": { "smithy.api#documentation": "The UPN that is an Internet-style login name for a user and is based on the Internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.
" } }, "EmailAddress": { "target": "com.amazonaws.directoryservicedata#EmailAddress", "traits": { "smithy.api#documentation": "The email address of the user.
" } }, "GivenName": { "target": "com.amazonaws.directoryservicedata#GivenName", "traits": { "smithy.api#documentation": "The first name of the user.
" } }, "Surname": { "target": "com.amazonaws.directoryservicedata#Surname", "traits": { "smithy.api#documentation": "The last name of the user.
" } }, "Enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the user account is active.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "The attribute values that are returned for the attribute names that are included in the\n request.
\nAttribute names are case insensitive.
\nAmazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information\n about Directory Service Data operations and object types.
\n With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from\n your Managed Microsoft AD without additional costs and without deploying dedicated management\n instances. You can also perform built-in object management tasks across directories without\n direct network connectivity, which simplifies provisioning and access management to achieve\n fully automated deployments. Directory Service Data supports user and group write operations, such as\n CreateUser and CreateGroup, within the organizational unit (OU) of\n your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and\n ListGroups, on all users, groups, and group memberships within your\n Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in\n your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles\n and permissions. For more information, see Manage users and\n groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service\n API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay\n between management changes, such as adding a new directory trust and calling the Directory Service Data API\n for the newly created trusted realm.
\nDirectory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on\n underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain\n controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data\n uses an available domain controller. As a result, you might notice eventual consistency while\n objects replicate from one domain controller to another domain controller. For more\n information, see What\n gets created in the Directory Service Administration Guide.\n Directory limits vary by Managed Microsoft AD edition:
\n\n Standard edition \u2013 Supports 8 transactions per\n second (TPS) for read operations and 4 TPS for write operations per directory. There's a\n concurrency limit of 10 concurrent requests.
\n\n Enterprise edition \u2013 Supports 16 transactions per\n second (TPS) for read operations and 8 TPS for write operations per directory. There's a\n concurrency limit of 10 concurrent requests.
\n\n Amazon Web Services Account - Supports a total of 100 TPS for\n Directory Service Data operations across all directories.
\nDirectory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary\n Amazon Web Services Region. For more information, see Managed Microsoft AD\n and Primary vs additional Regions in the Directory Service Administration\n Guide.
", "smithy.api#title": "AWS Directory Service Data", "smithy.api#xmlNamespace": { "uri": "http://directoryservicedata.amazonaws.com/doc/2023-05-31/" }, "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-data-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-data-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-data.{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-data.{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": [], "rules": [ { "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" } ], "type": "tree" }, { "conditions": [], "rules": [ { "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds-data-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds-data-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds-data.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://ds-data.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-data-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-data.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-data-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-data-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-data.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-data-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 enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ds-data.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ds-data.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "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.directoryservicedata#DirectoryUnavailableException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservicedata#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableReason", "traits": { "smithy.api#documentation": "Reason the request failed for the specified directory.
" } } }, "traits": { "smithy.api#documentation": "The request could not be completed due to a problem in the configuration or current state\n of the specified directory.
", "smithy.api#error": "client", "smithy.api#httpError": 400, "smithy.api#retryable": {} } }, "com.amazonaws.directoryservicedata#DirectoryUnavailableReason": { "type": "enum", "members": { "INVALID_DIRECTORY_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_DIRECTORY_STATE" } }, "DIRECTORY_TIMEOUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_TIMEOUT" } }, "DIRECTORY_RESOURCES_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_RESOURCES_EXCEEDED" } }, "NO_DISK_SPACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_DISK_SPACE" } }, "TRUST_AUTH_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRUST_AUTH_FAILURE" } } } }, "com.amazonaws.directoryservicedata#DisableUser": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#DisableUserRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#DisableUserResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Deactivates an active user account. For information about how to enable an inactive user\n account, see ResetUserPassword\n in the Directory Service API Reference.
", "smithy.api#examples": [ { "title": "To disable a user account", "documentation": "The following command disables the account for twhitlock.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "SAMAccountName": "twhitlock" }, "output": {} } ], "smithy.api#http": { "uri": "/Users/DisableUser", "method": "POST" } } }, "com.amazonaws.directoryservicedata#DisableUserRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.directoryservicedata#ClientToken", "traits": { "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe unique security identifier (SID) of the group.
" } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "DistinguishedName": { "target": "com.amazonaws.directoryservicedata#DistinguishedName", "traits": { "smithy.api#documentation": "The distinguished name of the object.
" } }, "GroupType": { "target": "com.amazonaws.directoryservicedata#GroupType", "traits": { "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" } }, "GroupScope": { "target": "com.amazonaws.directoryservicedata#GroupScope", "traits": { "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups\n
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "An expression of one or more attributes, data types, and the values of a group.
" } } }, "traits": { "smithy.api#documentation": "A group object that contains identifying information and attributes for a specified\n group.
" } }, "com.amazonaws.directoryservicedata#GroupList": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#Group" } }, "com.amazonaws.directoryservicedata#GroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[^:;|=+\"*?<>/\\\\,\\[\\]@]+$" } }, "com.amazonaws.directoryservicedata#GroupScope": { "type": "enum", "members": { "DOMAIN_LOCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DomainLocal" } }, "GLOBAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Global" } }, "UNIVERSAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Universal" } }, "BUILTIN_LOCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BuiltinLocal" } } } }, "com.amazonaws.directoryservicedata#GroupSummary": { "type": "structure", "members": { "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the group.
", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "GroupType": { "target": "com.amazonaws.directoryservicedata#GroupType", "traits": { "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
", "smithy.api#required": {} } }, "GroupScope": { "target": "com.amazonaws.directoryservicedata#GroupScope", "traits": { "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A structure containing a subset of fields of a group object from a directory.
" } }, "com.amazonaws.directoryservicedata#GroupSummaryList": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#GroupSummary" } }, "com.amazonaws.directoryservicedata#GroupType": { "type": "enum", "members": { "DISTRIBUTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Distribution" } }, "SECURITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Security" } } } }, "com.amazonaws.directoryservicedata#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservicedata#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The operation didn't succeed because an internal error occurred. Try again later.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.directoryservicedata#LdapDisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[A-Za-z*][A-Za-z-*]*$" } }, "com.amazonaws.directoryservicedata#LdapDisplayNameList": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#LdapDisplayName" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.directoryservicedata#ListGroupMembers": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#ListGroupMembersRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#ListGroupMembersResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns member information for the specified group.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n ListGroupMembers.NextToken member contains a token that you pass in the next\n call to ListGroupMembers. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return members from a group outside of your\n Managed Microsoft AD domain. When no value is defined, only members of your Managed Microsoft AD groups are\n returned.
\nThis value is case insensitive.
\nThe domain name that's associated with the group member. This parameter defaults to the\n Managed Microsoft AD domain.
\nThis parameter is optional and case insensitive.
\nThe name of the group.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } }, "MaxResults": { "target": "com.amazonaws.directoryservicedata#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#ListGroupMembersResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "Identifier (ID) of the directory associated with the group.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the group.
" } }, "MemberRealm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the member.
" } }, "Members": { "target": "com.amazonaws.directoryservicedata#MemberList", "traits": { "smithy.api#documentation": "The member information that the request returns.
" } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#ListGroups": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#ListGroupsRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#ListGroupsResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns group information for the specified directory.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the ListGroups.NextToken\n member contains a token that you pass in the next call to ListGroups. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
Returns group information for the specified member.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n ListGroupsForMember.NextToken member contains a token that you pass in the next\n call to ListGroupsForMember. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the member.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive and defaults to your Managed Microsoft AD domain.
\nThe domain name that's associated with the group member.
\nThis parameter is optional, so you can limit your results to the group members in a\n specific domain.
\n This parameter is case insensitive and defaults to Realm\n
The SAMAccountName of the user, group, or computer that's a member of the\n group.
An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } }, "MaxResults": { "target": "com.amazonaws.directoryservicedata#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#ListGroupsForMemberResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the member.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain that's associated with the group.
" } }, "MemberRealm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain that's associated with the member.
" } }, "Groups": { "target": "com.amazonaws.directoryservicedata#GroupSummaryList", "traits": { "smithy.api#documentation": "The group information that the request returns.
" } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#ListGroupsRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name associated with the directory.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive.
\nAn encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } }, "MaxResults": { "target": "com.amazonaws.directoryservicedata#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#ListGroupsResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name associated with the group.
" } }, "Groups": { "target": "com.amazonaws.directoryservicedata#GroupSummaryList", "traits": { "smithy.api#documentation": "The group information that the request returns.
" } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#ListUsers": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#ListUsersRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#ListUsersResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns user information for the specified directory.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the ListUsers.NextToken\n member contains a token that you pass in the next call to ListUsers. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the user.
\nThis parameter is optional, so you can return users outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD users are returned.
\nThis value is case insensitive.
\nAn encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } }, "MaxResults": { "target": "com.amazonaws.directoryservicedata#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#ListUsersResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain that's associated with the user.
" } }, "Users": { "target": "com.amazonaws.directoryservicedata#UserSummaryList", "traits": { "smithy.api#documentation": "The user information that the request returns.
" } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 250 } } }, "com.amazonaws.directoryservicedata#Member": { "type": "structure", "members": { "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the group member.
", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#MemberName", "traits": { "smithy.api#documentation": "The name of the group member.
", "smithy.api#required": {} } }, "MemberType": { "target": "com.amazonaws.directoryservicedata#MemberType", "traits": { "smithy.api#documentation": "The AD type of the member object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A member object that contains identifying information for a specified member.
" } }, "com.amazonaws.directoryservicedata#MemberList": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#Member" } }, "com.amazonaws.directoryservicedata#MemberName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[^:;|=+\"*?<>/\\\\,\\[\\]@]+$" } }, "com.amazonaws.directoryservicedata#MemberType": { "type": "enum", "members": { "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER" } }, "GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GROUP" } }, "COMPUTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPUTER" } } } }, "com.amazonaws.directoryservicedata#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6144 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#NumberAttributeValue": { "type": "long", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#Realm": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+[.]?$" } }, "com.amazonaws.directoryservicedata#RemoveGroupMember": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#RemoveGroupMemberRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#RemoveGroupMemberResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a member from a group.
", "smithy.api#examples": [ { "title": "To remove a member from a group", "documentation": "The following command removes the specified member from the example.local domain.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "GroupName": "DevOps", "MemberName": "Pat Candella", "MemberRealm": "example.local" }, "output": {} } ], "smithy.api#http": { "uri": "/GroupMemberships/RemoveGroupMember", "method": "POST" } } }, "com.amazonaws.directoryservicedata#RemoveGroupMemberRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the member.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "GroupName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "MemberName": { "target": "com.amazonaws.directoryservicedata#MemberName", "traits": { "smithy.api#documentation": " The SAMAccountName of the user, group, or computer to remove from the group.\n
The domain name that's associated with the group member. This parameter defaults to the\n Managed Microsoft AD domain.
\nThis parameter is optional and case insensitive.
\nA unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe resource couldn't be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.directoryservicedata#SID": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.directoryservicedata#SearchGroups": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#SearchGroupsRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#SearchGroupsResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": " Searches the specified directory for a group. You can find groups that match the\n SearchString parameter with the value of their attributes included in the\n SearchString parameter.
This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the SearchGroups.NextToken\n member contains a token that you pass in the next call to SearchGroups. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SearchString": { "target": "com.amazonaws.directoryservicedata#SearchString", "traits": { "smithy.api#documentation": "The attribute value that you want to search for.
\n Wildcard (*) searches aren't supported. For a list of supported\n attributes, see Directory Service Data\n Attributes.
One or more data attributes that are used to search for a group. For a list of supported\n attributes, see Directory Service Data Attributes.\n
", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive.
\nAn encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } }, "MaxResults": { "target": "com.amazonaws.directoryservicedata#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#SearchGroupsResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain that's associated with the group.
" } }, "Groups": { "target": "com.amazonaws.directoryservicedata#GroupList", "traits": { "smithy.api#documentation": "The group information that the request returns.
" } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#SearchString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#SearchUsers": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#SearchUsersRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#SearchUsersResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": " Searches the specified directory for a user. You can find users that match the\n SearchString parameter with the value of their attributes included in the\n SearchString parameter.
This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the SearchUsers.NextToken\n member contains a token that you pass in the next call to SearchUsers. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain name that's associated with the user.
\nThis parameter is optional, so you can return users outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD users are returned.
\nThis value is case insensitive.
\nThe attribute value that you want to search for.
\n Wildcard (*) searches aren't supported. For a list of supported\n attributes, see Directory Service Data\n Attributes.
One or more data attributes that are used to search for a user. For a list of supported\n attributes, see Directory Service Data Attributes.\n
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } }, "MaxResults": { "target": "com.amazonaws.directoryservicedata#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.directoryservicedata#SearchUsersResult": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory where the address block is added.
" } }, "Realm": { "target": "com.amazonaws.directoryservicedata#Realm", "traits": { "smithy.api#documentation": "The domain that's associated with the user.
" } }, "Users": { "target": "com.amazonaws.directoryservicedata#UserList", "traits": { "smithy.api#documentation": "The user information that the request returns.
" } }, "NextToken": { "target": "com.amazonaws.directoryservicedata#NextToken", "traits": { "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.directoryservicedata#StringAttributeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#StringSetAttributeValue": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#StringAttributeValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#Surname": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservicedata#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "RetryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The recommended amount of seconds to retry after a throttling exception.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "The limit on the number of requests per second has been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.directoryservicedata#UpdateGroup": { "type": "operation", "input": { "target": "com.amazonaws.directoryservicedata#UpdateGroupRequest" }, "output": { "target": "com.amazonaws.directoryservicedata#UpdateGroupResult" }, "errors": [ { "target": "com.amazonaws.directoryservicedata#AccessDeniedException" }, { "target": "com.amazonaws.directoryservicedata#ConflictException" }, { "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" }, { "target": "com.amazonaws.directoryservicedata#InternalServerException" }, { "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" }, { "target": "com.amazonaws.directoryservicedata#ThrottlingException" }, { "target": "com.amazonaws.directoryservicedata#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates group information.
", "smithy.api#examples": [ { "title": "To update a group", "documentation": "The following command updates the preferred language and country attributes for the GuestsLocal group.", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "GroupScope": "Global", "GroupType": "Security", "OtherAttributes": { "preferredLanguage": { "S": "English" }, "co": { "S": "US" } }, "SAMAccountName": "GuestsLocal", "UpdateType": "REPLACE" }, "output": {} } ], "smithy.api#http": { "uri": "/Groups/UpdateGroup", "method": "POST" } } }, "com.amazonaws.directoryservicedata#UpdateGroupRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#GroupName", "traits": { "smithy.api#documentation": "The name of the group.
", "smithy.api#required": {} } }, "GroupType": { "target": "com.amazonaws.directoryservicedata#GroupType", "traits": { "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" } }, "GroupScope": { "target": "com.amazonaws.directoryservicedata#GroupScope", "traits": { "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "An expression that defines one or more attributes with the data type and the value of\n each attribute.
" } }, "UpdateType": { "target": "com.amazonaws.directoryservicedata#UpdateType", "traits": { "smithy.api#documentation": " The type of update to be performed. If no value exists for the attribute, use\n ADD. Otherwise, use REPLACE to change an attribute value or\n REMOVE to clear the attribute value.
A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nUpdates user information.
", "smithy.api#examples": [ { "title": "To update user attributes", "documentation": "The following command", "input": { "ClientToken": "550e8400-e29b-41d4-a716-446655440000", "DirectoryId": "d-12233abcde", "EmailAddress": "twhitlock@examplecorp.com", "GivenName": "Terry", "OtherAttributes": { "telephoneNumber": { "S": "212-555-1111" }, "homePhone": { "S": "333-333-3333" }, "physicalDeliveryOfficeName": { "S": "Example Company" }, "streetAddress": { "S": "123 Any Street" }, "postalCode": { "S": "54321" }, "st": { "S": "WA" }, "co": { "S": "US" } }, "SAMAccountName": "twhitlock", "Surname": "Whitlock", "UpdateType": "ADD" }, "output": {} } ], "smithy.api#http": { "uri": "/Users/UpdateUser", "method": "POST" } } }, "com.amazonaws.directoryservicedata#UpdateUserRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.directoryservicedata#DirectoryId", "traits": { "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", "smithy.api#httpQuery": "DirectoryId", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "EmailAddress": { "target": "com.amazonaws.directoryservicedata#EmailAddress", "traits": { "smithy.api#documentation": "The email address of the user.
" } }, "GivenName": { "target": "com.amazonaws.directoryservicedata#GivenName", "traits": { "smithy.api#documentation": "The first name of the user.
" } }, "Surname": { "target": "com.amazonaws.directoryservicedata#Surname", "traits": { "smithy.api#documentation": "The last name of the user.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "An expression that defines one or more attribute names with the data type and value of\n each attribute. A key is an attribute name, and the value is a list of maps. For a list of\n supported attributes, see Directory Service Data Attributes.
\nAttribute names are case insensitive.
\n The type of update to be performed. If no value exists for the attribute, use\n ADD. Otherwise, use REPLACE to change an attribute value or\n REMOVE to clear the attribute value.
A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe unique security identifier (SID) of the user.
" } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "DistinguishedName": { "target": "com.amazonaws.directoryservicedata#DistinguishedName", "traits": { "smithy.api#documentation": "The distinguished name of the object.
" } }, "UserPrincipalName": { "target": "com.amazonaws.directoryservicedata#UserPrincipalName", "traits": { "smithy.api#documentation": "The UPN that is an internet-style login name for a user and based on the internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.
" } }, "EmailAddress": { "target": "com.amazonaws.directoryservicedata#EmailAddress", "traits": { "smithy.api#documentation": "The email address of the user.
" } }, "GivenName": { "target": "com.amazonaws.directoryservicedata#GivenName", "traits": { "smithy.api#documentation": "The first name of the user.
" } }, "Surname": { "target": "com.amazonaws.directoryservicedata#Surname", "traits": { "smithy.api#documentation": "The last name of the user.
" } }, "Enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the user account is active.
" } }, "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { "smithy.api#documentation": "An expression that includes one or more attributes, data types, and values of a\n user.
" } } }, "traits": { "smithy.api#documentation": "A user object that contains identifying information and attributes for a specified user.\n
" } }, "com.amazonaws.directoryservicedata#UserList": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#User" } }, "com.amazonaws.directoryservicedata#UserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^[\\w\\-.]+$" } }, "com.amazonaws.directoryservicedata#UserPrincipalName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.directoryservicedata#UserSummary": { "type": "structure", "members": { "SID": { "target": "com.amazonaws.directoryservicedata#SID", "traits": { "smithy.api#documentation": "The unique security identifier (SID) of the user.
", "smithy.api#required": {} } }, "SAMAccountName": { "target": "com.amazonaws.directoryservicedata#UserName", "traits": { "smithy.api#documentation": "The name of the user.
", "smithy.api#required": {} } }, "GivenName": { "target": "com.amazonaws.directoryservicedata#GivenName", "traits": { "smithy.api#documentation": "The first name of the user.
" } }, "Surname": { "target": "com.amazonaws.directoryservicedata#Surname", "traits": { "smithy.api#documentation": "The last name of the user.
" } }, "Enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the user account is active.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A structure containing a subset of the fields of a user object from a directory.
" } }, "com.amazonaws.directoryservicedata#UserSummaryList": { "type": "list", "member": { "target": "com.amazonaws.directoryservicedata#UserSummary" } }, "com.amazonaws.directoryservicedata#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.directoryservicedata#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.directoryservicedata#ValidationExceptionReason", "traits": { "smithy.api#documentation": "Reason the request failed validation.
" } } }, "traits": { "smithy.api#documentation": "The request isn't valid. Review the details in the error message to update the invalid\n parameters or values in your request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.directoryservicedata#ValidationExceptionReason": { "type": "enum", "members": { "INVALID_REALM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_REALM" } }, "INVALID_DIRECTORY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_DIRECTORY_TYPE" } }, "INVALID_SECONDARY_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SECONDARY_REGION" } }, "INVALID_NEXT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_NEXT_TOKEN" } }, "INVALID_ATTRIBUTE_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ATTRIBUTE_VALUE" } }, "INVALID_ATTRIBUTE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ATTRIBUTE_NAME" } }, "INVALID_ATTRIBUTE_FOR_USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_USER" } }, "INVALID_ATTRIBUTE_FOR_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_GROUP" } }, "INVALID_ATTRIBUTE_FOR_SEARCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_SEARCH" } }, "INVALID_ATTRIBUTE_FOR_MODIFY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_MODIFY" } }, "DUPLICATE_ATTRIBUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUPLICATE_ATTRIBUTE" } }, "MISSING_ATTRIBUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_ATTRIBUTE" } }, "ATTRIBUTE_EXISTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTRIBUTE_EXISTS" } }, "LDAP_SIZE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LDAP_SIZE_LIMIT_EXCEEDED" } }, "LDAP_UNSUPPORTED_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LDAP_UNSUPPORTED_OPERATION" } } } } } }