{
"smithy": "2.0",
"shapes": {
"com.amazonaws.identitystore#AWSIdentityStore": {
"type": "service",
"version": "2020-06-15",
"resources": [
{
"target": "com.amazonaws.identitystore#GroupMembershipResource"
},
{
"target": "com.amazonaws.identitystore#GroupResource"
},
{
"target": "com.amazonaws.identitystore#IdentityStoreResource"
},
{
"target": "com.amazonaws.identitystore#UserResource"
}
],
"errors": [
{
"target": "com.amazonaws.identitystore#AccessDeniedException"
},
{
"target": "com.amazonaws.identitystore#InternalServerException"
},
{
"target": "com.amazonaws.identitystore#ThrottlingException"
}
],
"traits": {
"aws.api#service": {
"sdkId": "identitystore",
"arnNamespace": "identitystore",
"cloudFormationName": "IdentityStore",
"cloudTrailEventSource": "identitystore.amazonaws.com",
"endpointPrefix": "identitystore"
},
"aws.auth#sigv4": {
"name": "identitystore"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": " IAM Identity Center uses the sso, sso-directory, and identitystore API namespaces. The sso-directory and identitystore namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.
The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). You can use the identity store API operations in this guide to manage your identity data programmatically. The scope of these APIs allows you to create, read, update, delete, and list users, groups, and memberships.
This guide also describes identity store operations that you can call and includes detailed information about data types and errors.
If you use an external identity provider or Active Directory as your identity source, we recommend that you use the Create, Update, and Delete APIs with caution. Because IAM Identity Center doesn't support outbound synchronization, your identity source won't automatically update with the changes that you make to users or groups using these APIs.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to programmatically access the identity store and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Amazon Web Services Builder Center Toolbox.
", "smithy.api#title": "AWS SSO Identity Store", "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 ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "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://identitystore-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://identitystore.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://identitystore-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://identitystore.{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://identitystore.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "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://identitystore-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": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://identitystore.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://identitystore-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://identitystore.{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://identitystore.{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 ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.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://identitystore.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.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://identitystore.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://identitystore.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://identitystore.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.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://identitystore.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.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://identitystore.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://identitystore-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://identitystore-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://identitystore.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://identitystore-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://identitystore-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://identitystore.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://identitystore.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore.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://identitystore.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://identitystore.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://identitystore.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://identitystore-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://identitystore.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 enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identitystore-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://identitystore.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://identitystore-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://identitystore.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.identitystore#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { "smithy.api#documentation": "The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } }, "Reason": { "target": "com.amazonaws.identitystore#AccessDeniedExceptionReason", "traits": { "smithy.api#documentation": "Indicates the reason for an access denial when returned by KMS while accessing a Customer Managed KMS key. For non-KMS access-denied errors, this field is not included.
" } } }, "traits": { "smithy.api#documentation": "You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.identitystore#AccessDeniedExceptionReason": { "type": "enum", "members": { "KMS_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_ACCESS_DENIED" } } } }, "com.amazonaws.identitystore#Address": { "type": "structure", "members": { "StreetAddress": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The street of the address.
" } }, "Locality": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string of the address locality.
" } }, "Region": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The region of the address.
" } }, "PostalCode": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The postal code of the address.
" } }, "Country": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The country of the address.
" } }, "Formatted": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing a formatted version of the address for display.
" } }, "Type": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string representing the type of address. For example, \"Home.\"
" } }, "Primary": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A Boolean value representing whether this is the primary address for the associated resource.
" } } }, "traits": { "smithy.api#documentation": "The address associated with the specified user.
" } }, "com.amazonaws.identitystore#Addresses": { "type": "list", "member": { "target": "com.amazonaws.identitystore#Address" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.identitystore#AlternateIdentifier": { "type": "union", "members": { "ExternalId": { "target": "com.amazonaws.identitystore#ExternalId", "traits": { "smithy.api#documentation": "The identifier issued to this resource by an external identity provider.
" } }, "UniqueAttribute": { "target": "com.amazonaws.identitystore#UniqueAttribute", "traits": { "smithy.api#documentation": "An entity attribute that's unique to a specific entity.
" } } }, "traits": { "smithy.api#documentation": "A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute.
" } }, "com.amazonaws.identitystore#AttributeOperation": { "type": "structure", "members": { "AttributePath": { "target": "com.amazonaws.identitystore#AttributePath", "traits": { "smithy.api#documentation": "A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
", "smithy.api#required": {} } }, "AttributeValue": { "target": "com.amazonaws.identitystore#AttributeValue", "traits": { "smithy.api#documentation": "The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
An operation that applies to the requested group. This operation might add, replace, or remove an attribute.
" } }, "com.amazonaws.identitystore#AttributeOperations": { "type": "list", "member": { "target": "com.amazonaws.identitystore#AttributeOperation" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.identitystore#AttributePath": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?:\\p{L}+:\\p{L}+:\\p{L}+(?:\\.\\p{L}+){0,3}|\\p{L}+(?:\\.\\p{L}+){0,2})$" } }, "com.amazonaws.identitystore#AttributeValue": { "type": "document", "traits": { "smithy.api#documentation": "The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } }, "Reason": { "target": "com.amazonaws.identitystore#ConflictExceptionReason", "traits": { "smithy.api#documentation": "Indicates the reason for a conflict error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
" } } }, "traits": { "smithy.api#documentation": "This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
Creates a group within the specified identity store.
" } }, "com.amazonaws.identitystore#CreateGroupMembership": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#CreateGroupMembershipRequest" }, "output": { "target": "com.amazonaws.identitystore#CreateGroupMembershipResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ConflictException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ServiceQuotaExceededException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "MembershipId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a newly created GroupMembership in an identity store.
The Amazon Resource Name (ARN) of the newly created group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
A string containing the name of the group. This value is commonly displayed when the group is referenced. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.
A string containing the description of the group.
" } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#CreateGroupResponse": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "GroupId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier of the newly created group in the identity store.
", "smithy.api#required": {} } }, "GroupArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The revision of the newly created group in the identity store.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#CreateUser": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#CreateUserRequest" }, "output": { "target": "com.amazonaws.identitystore#CreateUserResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ConflictException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ServiceQuotaExceededException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a user within the specified identity store.
" } }, "com.amazonaws.identitystore#CreateUserRequest": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.
An object containing the name of the user. When used in IAM Identity Center, this parameter is required.
" } }, "DisplayName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, \"John Doe.\" When used in IAM Identity Center, this parameter is required.
" } }, "NickName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing an alternate name for the user.
" } }, "ProfileUrl": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing a URL that might be associated with the user.
" } }, "Emails": { "target": "com.amazonaws.identitystore#Emails", "traits": { "smithy.api#documentation": "A list of Email objects containing email addresses associated with the user.
A list of Address objects containing addresses associated with the user.
A list of PhoneNumber objects containing phone numbers associated with the user.
A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
" } }, "Title": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
" } }, "PreferredLanguage": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the preferred language of the user. For example, \"American English\" or \"en-us.\"
" } }, "Locale": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the geographical region or location of the user.
" } }, "Timezone": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the time zone of the user.
" } }, "Photos": { "target": "com.amazonaws.identitystore#Photos", "traits": { "smithy.api#documentation": "A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.
" } }, "Website": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.
" } }, "Birthdate": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.
" } }, "Roles": { "target": "com.amazonaws.identitystore#Roles", "traits": { "smithy.api#documentation": "A list of Role objects containing roles associated with the user.
A map with additional attribute extensions for the user. Each map key corresponds to an extension name, while map values represent extension data in Document type (not supported by Java V1, Go V1 and older versions of the CLI). aws:identitystore:enterprise is the only supported extension name.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier of the newly created user in the identity store.
", "smithy.api#required": {} } }, "UserArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The revision of the newly created user in the identity store.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#DateType": { "type": "timestamp" }, "com.amazonaws.identitystore#DeleteGroup": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#DeleteGroupRequest" }, "output": { "target": "com.amazonaws.identitystore#DeleteGroupResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ConflictException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Delete a group within an identity store given GroupId.
Delete a membership within a group given MembershipId.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a GroupMembership in an identity store.
You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 or membership ARN arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The expected current revision of the group. When you provide this value, the group is deleted only if it matches the current revision of the group in the identity store. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the group is deleted regardless of its current revision.
Deletes a user within an identity store given UserId.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the user is deleted regardless of its current revision.
Retrieves the group metadata and attributes from GroupId in an identity store.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
Retrieves membership metadata and attributes from MembershipId in an identity store.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a GroupMembership in an identity store.
You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 or membership ARN arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "MembershipId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a GroupMembership in an identity store.
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "MemberId": { "target": "com.amazonaws.identitystore#MemberId", "traits": { "smithy.api#required": {} } }, "CreatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group membership was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group membership was last updated.
" } }, "CreatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that created the group membership.
" } }, "UpdatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that last updated the group membership.
" } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#GroupResource" }, { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#DescribeGroupRequest": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "GroupId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "GroupArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The current revision of the group in the identity store. This value changes each time the group is modified.
", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.identitystore#GroupDisplayName", "traits": { "smithy.api#documentation": "The group\u2019s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.
" } }, "ExternalIds": { "target": "com.amazonaws.identitystore#ExternalIds", "traits": { "smithy.api#documentation": "A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
A string containing a description of the group.
" } }, "CreatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group was last updated.
" } }, "CreatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that created the group.
" } }, "UpdatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that last updated the group.
" } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#DescribeIdentityStore": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#DescribeIdentityStoreRequest" }, "output": { "target": "com.amazonaws.identitystore#DescribeIdentityStoreResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.
", "smithy.api#readonly": {} } }, "com.amazonaws.identitystore#DescribeIdentityStoreRequest": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "IdentityStoreArn": { "target": "com.amazonaws.identitystore#IdentityStoreArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The network configuration of the identity store. This configuration controls whether access through a virtual private cloud (VPC) endpoint is required, and which source VPCs and IP addresses are allowed.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.identitystore#DescribeUser": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#DescribeUserRequest" }, "output": { "target": "com.amazonaws.identitystore#DescribeUserResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the user metadata and attributes from the UserId in an identity store.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a user in the identity store.
", "smithy.api#required": {} } }, "UserArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The current revision of the user in the identity store. This value changes each time the user is modified.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.identitystore#UserName", "traits": { "smithy.api#documentation": "A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
" } }, "ExternalIds": { "target": "com.amazonaws.identitystore#ExternalIds", "traits": { "smithy.api#documentation": "A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
The name of the user.
" } }, "DisplayName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The display name of the user.
" } }, "NickName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "An alternative descriptive name for the user.
" } }, "ProfileUrl": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A URL link for the user's profile.
" } }, "Emails": { "target": "com.amazonaws.identitystore#Emails", "traits": { "smithy.api#documentation": "The email address of the user.
" } }, "Addresses": { "target": "com.amazonaws.identitystore#Addresses", "traits": { "smithy.api#documentation": "The physical address of the user.
" } }, "PhoneNumbers": { "target": "com.amazonaws.identitystore#PhoneNumbers", "traits": { "smithy.api#documentation": "A list of PhoneNumber objects associated with a user.
A string indicating the type of user.
" } }, "Title": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the title of the user.
" } }, "PreferredLanguage": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The preferred language of the user.
" } }, "Locale": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the geographical region or location of the user.
" } }, "Timezone": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The time zone for a user.
" } }, "UserStatus": { "target": "com.amazonaws.identitystore#UserStatus", "traits": { "smithy.api#documentation": "The current status of the user account.
" } }, "Photos": { "target": "com.amazonaws.identitystore#Photos", "traits": { "smithy.api#documentation": "A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.
" } }, "Website": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The user's personal website or blog URL. Returns the stored website information for the user.
" } }, "Birthdate": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.
" } }, "Roles": { "target": "com.amazonaws.identitystore#Roles", "traits": { "smithy.api#documentation": "The roles of the user.
" } }, "CreatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the user was created.
" } }, "CreatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that created the user.
" } }, "UpdatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the user was last updated.
" } }, "UpdatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that last updated the user.
" } }, "Extensions": { "target": "com.amazonaws.identitystore#Extensions", "traits": { "smithy.api#documentation": "A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.
" } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#Email": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing an email address. For example, \"johndoe@amazon.com.\"
" } }, "Type": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string representing the type of address. For example, \"Work.\"
" } }, "Primary": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A Boolean value representing whether this is the primary email address for the associated resource.
" } } }, "traits": { "smithy.api#documentation": "The email address associated with the user.
" } }, "com.amazonaws.identitystore#Emails": { "type": "list", "member": { "target": "com.amazonaws.identitystore#Email" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.identitystore#ExceptionMessage": { "type": "string" }, "com.amazonaws.identitystore#ExtensionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^aws:identitystore:[a-z]{1,20}$" } }, "com.amazonaws.identitystore#ExtensionNames": { "type": "list", "member": { "target": "com.amazonaws.identitystore#ExtensionName" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.identitystore#Extensions": { "type": "map", "key": { "target": "com.amazonaws.identitystore#ExtensionName" }, "value": { "target": "com.amazonaws.identitystore#AttributeValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.identitystore#ExternalId": { "type": "structure", "members": { "Issuer": { "target": "com.amazonaws.identitystore#ExternalIdIssuer", "traits": { "smithy.api#documentation": "The issuer for an external identifier.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.identitystore#ExternalIdIdentifier", "traits": { "smithy.api#documentation": "The identifier issued to this resource by an external identity provider.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The identifier issued to this resource by an external identity provider.
" } }, "com.amazonaws.identitystore#ExternalIdIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.identitystore#ExternalIdIssuer": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.identitystore#ExternalIds": { "type": "list", "member": { "target": "com.amazonaws.identitystore#ExternalId" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.identitystore#Filter": { "type": "structure", "members": { "AttributePath": { "target": "com.amazonaws.identitystore#AttributePath", "traits": { "smithy.api#documentation": "The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
Represents the data for an attribute. Each attribute value is described as a name-value pair.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.
Retrieves GroupId in an identity store.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "GroupId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "GroupArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Retrieves the MembershipId in an identity store.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "MembershipId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a GroupMembership in an identity store.
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
Retrieves the UserId in an identity store.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are userName and emails.value.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a user in the identity store.
", "smithy.api#required": {} } }, "UserArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "GroupId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "GroupArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the Revision parameter of an UpdateGroup or DeleteGroup request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.
The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
Prefix search supports a maximum of 1,000 characters for the string.
" } }, "ExternalIds": { "target": "com.amazonaws.identitystore#ExternalIds", "traits": { "smithy.api#documentation": "A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
A string containing a description of the specified group.
" } }, "CreatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group was last updated.
" } }, "CreatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that created the group.
" } }, "UpdatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that last updated the group.
" } } }, "traits": { "smithy.api#documentation": "A group object that contains the metadata and attributes for a specified group.
", "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#GroupDisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r \u00a0\u3000]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.identitystore#GroupIds": { "type": "list", "member": { "target": "com.amazonaws.identitystore#ResourceId" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.identitystore#GroupMembership": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "MembershipId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a GroupMembership object in an identity store.
The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.
The identifier for a group in the identity store.
" } }, "MemberId": { "target": "com.amazonaws.identitystore#MemberId", "traits": { "smithy.api#documentation": "An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
The date and time the group membership was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the group membership was last updated.
" } }, "CreatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that created the group membership.
" } }, "UpdatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that last updated the group membership.
" } } }, "traits": { "smithy.api#documentation": "Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.
The identifier for a group in the identity store.
" } }, "MemberId": { "target": "com.amazonaws.identitystore#MemberId", "traits": { "smithy.api#documentation": "An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
Indicates whether a membership relation exists or not.
" } } }, "traits": { "smithy.api#documentation": "Indicates whether a resource is a member of a group in the identity store.
", "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#GroupResource" } ] } }, "com.amazonaws.identitystore#GroupMembershipExistenceResults": { "type": "list", "member": { "target": "com.amazonaws.identitystore#GroupMembershipExistenceResult" } }, "com.amazonaws.identitystore#GroupMembershipResource": { "type": "resource", "identifiers": { "MembershipId": { "target": "com.amazonaws.identitystore#ResourceId" } }, "create": { "target": "com.amazonaws.identitystore#CreateGroupMembership" }, "read": { "target": "com.amazonaws.identitystore#DescribeGroupMembership" }, "delete": { "target": "com.amazonaws.identitystore#DeleteGroupMembership" }, "list": { "target": "com.amazonaws.identitystore#ListGroupMemberships" }, "collectionOperations": [ { "target": "com.amazonaws.identitystore#GetGroupMembershipId" }, { "target": "com.amazonaws.identitystore#IsMemberInGroups" }, { "target": "com.amazonaws.identitystore#ListGroupMembershipsForMember" } ], "traits": { "aws.cloudformation#cfnResource": { "name": "GroupMembership" }, "smithy.api#documentation": "Resource Type definition for AWS::IdentityStore::GroupMembership" } }, "com.amazonaws.identitystore#GroupMemberships": { "type": "list", "member": { "target": "com.amazonaws.identitystore#GroupMembership" } }, "com.amazonaws.identitystore#GroupResource": { "type": "resource", "identifiers": { "GroupId": { "target": "com.amazonaws.identitystore#ResourceId" } }, "create": { "target": "com.amazonaws.identitystore#CreateGroup" }, "read": { "target": "com.amazonaws.identitystore#DescribeGroup" }, "update": { "target": "com.amazonaws.identitystore#UpdateGroup" }, "delete": { "target": "com.amazonaws.identitystore#DeleteGroup" }, "list": { "target": "com.amazonaws.identitystore#ListGroups" }, "collectionOperations": [ { "target": "com.amazonaws.identitystore#GetGroupId" } ], "traits": { "aws.cloudformation#cfnResource": { "name": "Group" }, "smithy.api#documentation": "Resource Type definition for AWS::IdentityStore::Group" } }, "com.amazonaws.identitystore#Groups": { "type": "list", "member": { "target": "com.amazonaws.identitystore#Group" } }, "com.amazonaws.identitystore#IdentityStore": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "IdentityStoreArn": { "target": "com.amazonaws.identitystore#IdentityStoreArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.
A structure that contains the identifiers for an identity store: its globally unique identifier (ID) and Amazon Resource Name (ARN).
" } }, "com.amazonaws.identitystore#IdentityStoreArn": { "type": "string", "traits": { "smithy.api#length": { "min": 62, "max": 93 }, "smithy.api#pattern": "^arn:aws[a-z-]*:identitystore::\\d{12}:identitystore/(d-[0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" } }, "com.amazonaws.identitystore#IdentityStoreId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 93 }, "smithy.api#pattern": "^(arn:aws[a-z-]*:identitystore::\\d{12}:identitystore/)?(d-[0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" } }, "com.amazonaws.identitystore#IdentityStoreResource": { "type": "resource", "identifiers": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId" } }, "read": { "target": "com.amazonaws.identitystore#DescribeIdentityStore" }, "update": { "target": "com.amazonaws.identitystore#UpdateIdentityStore" }, "list": { "target": "com.amazonaws.identitystore#ListIdentityStores" }, "traits": { "smithy.api#documentation": "Resource Type definition for IdentityStore" } }, "com.amazonaws.identitystore#IdentityStores": { "type": "list", "member": { "target": "com.amazonaws.identitystore#IdentityStore" } }, "com.amazonaws.identitystore#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { "smithy.api#documentation": "The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } }, "RetryAfterSeconds": { "target": "com.amazonaws.identitystore#RetryAfterSeconds", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds to wait before retrying the next request.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure with an internal server.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.identitystore#IpCidrList": { "type": "list", "member": { "target": "com.amazonaws.identitystore#IpCidrType" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.identitystore#IpCidrType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 43 }, "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])(\\/(3[0-2]|[1-2][0-9]|[0-9]))?|(([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[0-1][0-9]|[1-9][0-9]|[0-9]))?)$" } }, "com.amazonaws.identitystore#IsMemberInGroups": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#IsMemberInGroupsRequest" }, "output": { "target": "com.amazonaws.identitystore#IsMemberInGroupsResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
An object containing the identifier of a group member.
", "smithy.api#required": {} } }, "GroupIds": { "target": "com.amazonaws.identitystore#GroupIds", "traits": { "smithy.api#documentation": "A list of identifiers for groups in the identity store.
You can specify each group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
A list containing the results of membership existence checks.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.identitystore#ListGroupMemberships": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#ListGroupMembershipsRequest" }, "output": { "target": "com.amazonaws.identitystore#ListGroupMembershipsResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
A list of GroupMembership objects in the group for a specified member.
The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
A list of GroupMembership objects in the group.
The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
A list of Filter objects, which is used in the ListUsers and ListGroups requests.
A list of Group objects in the identity store.
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
Lists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To obtain additional information about an identity store, call DescribeIdentityStore.
This operation returns results in paginated form. Use the NextToken parameter to retrieve additional pages of results.
The maximum number of results to return per request. This parameter is used in all List operations to specify how many results to return on one page. If you don't specify a value, the operation uses a default page size.
The pagination token used for the ListIdentityStores API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
A list of IdentityStore objects, each of which contains the identifiers for an identity store that you have access to.
The pagination token used for the ListIdentityStores API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
A list of Filter objects, which is used in the ListUsers and ListGroups requests.
A list of User objects in the identity store.
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
An object containing the identifier of a group member.
" } }, "com.amazonaws.identitystore#Name": { "type": "structure", "members": { "Formatted": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing a formatted version of the name for display.
" } }, "FamilyName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The family name of the user.
" } }, "GivenName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The given name of the user.
" } }, "MiddleName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The middle name of the user.
" } }, "HonorificPrefix": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The honorific prefix of the user. For example, \"Dr.\"
" } }, "HonorificSuffix": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The honorific suffix of the user. For example, \"M.D.\"
" } } }, "traits": { "smithy.api#documentation": "The full name of the user.
" } }, "com.amazonaws.identitystore#NetworkConfiguration": { "type": "structure", "members": { "VpceAccessRequired": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.
This value must be set to either true or false when you provide NetworkConfiguration in a request.
A list of virtual private cloud (VPC) ARNs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if you specified one. If you don't specify a value, access isn't restricted to specific VPCs, but the VPC endpoint requirement set by VpceAccessRequired still applies.
A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by VpceAccessRequired, and even if it doesn't originate from a VPC in ApiRestrictSourceVpcs. If you don't specify a value, no such IP address exception applies.
A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If you don't specify a value, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement set by VpceAccessRequired.
For example, to allow SCIM traffic from the public internet while still requiring the identity store API operations to be accessed through a VPC endpoint, set VpceAccessRequired to true and set this value to 0.0.0.0/0.
The network configuration that controls how an identity store can be accessed. You provide this object in a request.
" } }, "com.amazonaws.identitystore#NetworkConfigurationDetails": { "type": "structure", "members": { "VpceAccessRequired": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.
A list of virtual private cloud (VPC) ARNs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if one is configured. If this field is empty, access isn't restricted to specific VPCs, but the VPC endpoint requirement from VpceAccessRequired still applies.
A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by VpceAccessRequired, and even if it doesn't originate from a VPC in ApiRestrictSourceVpcs. If this field is empty, no such IP address exception applies.
A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If this field is empty, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement.
" } } }, "traits": { "smithy.api#documentation": "The network configuration that controls how an identity store can be accessed. This object is returned as part of service API responses.
" } }, "com.amazonaws.identitystore#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65535 }, "smithy.api#pattern": "^[-a-zA-Z0-9+=/:_]*$" } }, "com.amazonaws.identitystore#PhoneNumber": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing a phone number. For example, \"8675309\" or \"+1 (800) 123-4567\".
" } }, "Type": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string representing the type of a phone number. For example, \"Mobile.\"
" } }, "Primary": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A Boolean value representing whether this is the primary phone number for the associated resource.
" } } }, "traits": { "smithy.api#documentation": "The phone number associated with the user.
" } }, "com.amazonaws.identitystore#PhoneNumbers": { "type": "list", "member": { "target": "com.amazonaws.identitystore#PhoneNumber" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.identitystore#Photo": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The type of photo. This field is optional and can be used to categorize different types of photos.
" } }, "Display": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A human-readable description of the photo for display purposes. This optional field provides context about the photo.
" } }, "Primary": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.
Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.
" } }, "com.amazonaws.identitystore#Photos": { "type": "list", "member": { "target": "com.amazonaws.identitystore#Photo" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.identitystore#RequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 }, "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.identitystore#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 60, "max": 100 }, "smithy.api#pattern": "^arn:aws[a-z-]*:identitystore:::(user|group|membership)/([0-9a-f]{10}-|)[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.identitystore#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^(arn:aws[a-z-]*:identitystore:::(user|group|membership)/)?([0-9a-f]{10}-|)[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.identitystore#ResourceNotFoundException": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.identitystore#ResourceType", "traits": { "smithy.api#documentation": "An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.
" } }, "ResourceId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a resource in the identity store that can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.
Indicates the reason for a resource not found error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
" } }, "Message": { "target": "com.amazonaws.identitystore#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { "smithy.api#documentation": "The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } } }, "traits": { "smithy.api#documentation": "Indicates that a requested resource is not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.identitystore#ResourceNotFoundExceptionReason": { "type": "enum", "members": { "KMS_KEY_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_KEY_NOT_FOUND" } } } }, "com.amazonaws.identitystore#ResourceRevision": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.identitystore#ResourceType": { "type": "enum", "members": { "GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GROUP" } }, "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER" } }, "IDENTITY_STORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDENTITY_STORE" } }, "GROUP_MEMBERSHIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GROUP_MEMBERSHIP" } }, "RESOURCE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_POLICY" } } } }, "com.amazonaws.identitystore#RetryAfterSeconds": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.identitystore#Role": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing a role name. For example, \"Researcher.\"
" } }, "Type": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string representing the type of role. For example, \"Work.\"
" } }, "Primary": { "target": "com.amazonaws.identitystore#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A Boolean value representing whether this is the primary role for the associated resource.
" } } }, "traits": { "smithy.api#documentation": "The role associated with the user.
" } }, "com.amazonaws.identitystore#Roles": { "type": "list", "member": { "target": "com.amazonaws.identitystore#Role" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.identitystore#SensitiveStringType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r \u00a0\u3000]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.identitystore#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { "smithy.api#documentation": "The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } } }, "traits": { "smithy.api#documentation": "The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.identitystore#StringType": { "type": "string" }, "com.amazonaws.identitystore#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { "smithy.api#documentation": "The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } }, "RetryAfterSeconds": { "target": "com.amazonaws.identitystore#RetryAfterSeconds", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds to wait before retrying the next request.
", "smithy.api#httpHeader": "Retry-After" } }, "Reason": { "target": "com.amazonaws.identitystore#ThrottlingExceptionReason", "traits": { "smithy.api#documentation": "Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
" } } }, "traits": { "smithy.api#documentation": "Indicates that the principal has crossed the throttling limits of the API operations.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.identitystore#ThrottlingExceptionReason": { "type": "enum", "members": { "KMS_THROTTLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_THROTTLING" } } } }, "com.amazonaws.identitystore#UniqueAttribute": { "type": "structure", "members": { "AttributePath": { "target": "com.amazonaws.identitystore#AttributePath", "traits": { "smithy.api#documentation": "A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
", "smithy.api#required": {} } }, "AttributeValue": { "target": "com.amazonaws.identitystore#AttributeValue", "traits": { "smithy.api#documentation": "The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.
An entity attribute that's unique to a specific entity.
" } }, "com.amazonaws.identitystore#UpdateGroup": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#UpdateGroupRequest" }, "output": { "target": "com.amazonaws.identitystore#UpdateGroupResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ConflictException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ServiceQuotaExceededException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the specified group metadata and attributes in the specified identity store.
" } }, "com.amazonaws.identitystore#UpdateGroupRequest": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see Group.
The expected current revision of the group. When you provide this value, the update is applied only if it matches the current revision of the group in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the update is applied unconditionally.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "GroupId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "GroupArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
The revision of the group after the requested update is applied.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#UpdateIdentityStore": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#UpdateIdentityStoreRequest" }, "output": { "target": "com.amazonaws.identitystore#UpdateIdentityStoreResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#ConflictException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the configuration of the specified identity store, including its network configuration.
" } }, "com.amazonaws.identitystore#UpdateIdentityStoreRequest": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The network configuration to apply to the identity store. This controls whether access through a virtual private cloud (VPC) endpoint is required and the source VPCs and IP addresses that are allowed to access the identity store.
When you provide NetworkConfiguration in a request, the service performs a full replacement of the identity store's current network configuration with the values you specify. Any values that you omit are cleared. To preserve or change the allowed source VPCs or IP address ranges, include the complete set of values that you want in the request. To clear a list, omit it; an empty list is not accepted.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "IdentityStoreArn": { "target": "com.amazonaws.identitystore#IdentityStoreArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.
Updates the specified user metadata and attributes in the specified identity store.
" } }, "com.amazonaws.identitystore#UpdateUserRequest": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see User.
The expected current revision of the user. When you provide this value, the update is applied only if it matches the current revision of the user in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the update is applied unconditionally.
The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a user in the identity store.
", "smithy.api#required": {} } }, "UserArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The revision of the user after the requested update is applied.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#User": { "type": "structure", "members": { "IdentityStoreId": { "target": "com.amazonaws.identitystore#IdentityStoreId", "traits": { "smithy.api#documentation": "The globally unique identifier for the identity store.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a user in the identity store.
", "smithy.api#required": {} } }, "UserArn": { "target": "com.amazonaws.identitystore#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The current revision of the user in the identity store. This value changes each time the user is modified. You can provide it as the Revision parameter of an UpdateUser or DeleteUser request to make the operation conditional on the user not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
" } }, "ExternalIds": { "target": "com.amazonaws.identitystore#ExternalIds", "traits": { "smithy.api#documentation": "A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
An object containing the name of the user.
" } }, "DisplayName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the name of the user that is formatted for display when the user is referenced. For example, \"John Doe.\"
Prefix search supports a maximum of 1,000 characters for the string.
" } }, "NickName": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing an alternate name for the user.
" } }, "ProfileUrl": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing a URL that might be associated with the user.
" } }, "Emails": { "target": "com.amazonaws.identitystore#Emails", "traits": { "smithy.api#documentation": "A list of Email objects containing email addresses associated with the user.
A list of Address objects containing addresses associated with the user.
A list of PhoneNumber objects containing phone numbers associated with the user.
A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
" } }, "Title": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
" } }, "PreferredLanguage": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the preferred language of the user. For example, \"American English\" or \"en-us.\"
" } }, "Locale": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the geographical region or location of the user.
" } }, "Timezone": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "A string containing the time zone of the user.
" } }, "UserStatus": { "target": "com.amazonaws.identitystore#UserStatus", "traits": { "smithy.api#documentation": "The current status of the user account.
" } }, "Photos": { "target": "com.amazonaws.identitystore#Photos", "traits": { "smithy.api#documentation": "A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.
" } }, "Website": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The user's personal website or blog URL. This field stores website information for personal or professional use.
" } }, "Birthdate": { "target": "com.amazonaws.identitystore#SensitiveStringType", "traits": { "smithy.api#documentation": "The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.
" } }, "Roles": { "target": "com.amazonaws.identitystore#Roles", "traits": { "smithy.api#documentation": "A list of Role objects containing roles associated with the user.
The date and time the user was created.
" } }, "CreatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that created the user.
" } }, "UpdatedAt": { "target": "com.amazonaws.identitystore#DateType", "traits": { "smithy.api#documentation": "The date and time the user was last updated.
" } }, "UpdatedBy": { "target": "com.amazonaws.identitystore#StringType", "traits": { "smithy.api#documentation": "The identifier of the user or system that last updated the user.
" } }, "Extensions": { "target": "com.amazonaws.identitystore#Extensions", "traits": { "smithy.api#documentation": "A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.
" } } }, "traits": { "smithy.api#documentation": "A user object that contains the metadata and attributes for a specified user.
", "smithy.api#references": [ { "resource": "com.amazonaws.identitystore#IdentityStoreResource" } ] } }, "com.amazonaws.identitystore#UserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.identitystore#UserResource": { "type": "resource", "identifiers": { "UserId": { "target": "com.amazonaws.identitystore#ResourceId" } }, "create": { "target": "com.amazonaws.identitystore#CreateUser" }, "read": { "target": "com.amazonaws.identitystore#DescribeUser" }, "update": { "target": "com.amazonaws.identitystore#UpdateUser" }, "delete": { "target": "com.amazonaws.identitystore#DeleteUser" }, "list": { "target": "com.amazonaws.identitystore#ListUsers" }, "collectionOperations": [ { "target": "com.amazonaws.identitystore#GetUserId" } ], "traits": { "aws.cloudformation#cfnResource": { "name": "User" }, "smithy.api#documentation": "Resource Type definition for AWS::IdentityStore::User" } }, "com.amazonaws.identitystore#UserStatus": { "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.identitystore#Users": { "type": "list", "member": { "target": "com.amazonaws.identitystore#User" } }, "com.amazonaws.identitystore#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#ExceptionMessage" }, "RequestId": { "target": "com.amazonaws.identitystore#RequestId", "traits": { "smithy.api#documentation": "The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
" } }, "Reason": { "target": "com.amazonaws.identitystore#ValidationExceptionReason", "traits": { "smithy.api#documentation": "Indicates the reason for the validation error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
" } } }, "traits": { "smithy.api#documentation": "The request failed because it contains a syntax error.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.identitystore#ValidationExceptionReason": { "type": "enum", "members": { "KMS_INVALID_ARN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_INVALID_ARN" } }, "KMS_INVALID_KEY_USAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_INVALID_KEY_USAGE" } }, "KMS_INVALID_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_INVALID_STATE" } }, "KMS_DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_DISABLED" } } } }, "com.amazonaws.identitystore#VpcArn": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 128 }, "smithy.api#pattern": "^(arn:aws(-[a-z]{1,5}){0,3}:ec2:[a-z]{2,4}(-[a-z]{1,10}){1,3}-[0-9]{1,2}:[0-9]{12}:vpc/)?vpc-([0-9a-f]){8}(([0-9a-f]){9})?$" } }, "com.amazonaws.identitystore#VpcArnList": { "type": "list", "member": { "target": "com.amazonaws.identitystore#VpcArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#uniqueItems": {} } } } }