{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.identitystore#AWSIdentityStore": { "type": "service", "version": "2020-06-15", "operations": [ { "target": "com.amazonaws.identitystore#DescribeGroup" }, { "target": "com.amazonaws.identitystore#DescribeUser" }, { "target": "com.amazonaws.identitystore#ListGroups" }, { "target": "com.amazonaws.identitystore#ListUsers" } ], "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#title": "AWS SSO Identity Store" } }, "com.amazonaws.identitystore#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#Message" }, "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": "You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.identitystore#AttributePath": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P} ]+" } }, "com.amazonaws.identitystore#DescribeGroup": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#DescribeGroupRequest" }, "output": { "target": "com.amazonaws.identitystore#DescribeGroupResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#AccessDeniedException" }, { "target": "com.amazonaws.identitystore#InternalServerException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ThrottlingException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the group metadata and attributes from GroupId
in an identity store.
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 which contains number and lower case letters. This value is generated at the time that a new identity store is created.
", "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": {} } } } }, "com.amazonaws.identitystore#DescribeGroupResponse": { "type": "structure", "members": { "GroupId": { "target": "com.amazonaws.identitystore#ResourceId", "traits": { "smithy.api#documentation": "The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.identitystore#GroupDisplayName", "traits": { "smithy.api#documentation": "Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “<>;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
", "smithy.api#required": {} } } } }, "com.amazonaws.identitystore#DescribeUser": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#DescribeUserRequest" }, "output": { "target": "com.amazonaws.identitystore#DescribeUserResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#AccessDeniedException" }, { "target": "com.amazonaws.identitystore#InternalServerException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ThrottlingException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the user metadata and attributes from UserId
in an identity store.
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 which contains number and lower case letters. This value is generated at the time that a new identity store is created.
", "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": {} } } } }, "com.amazonaws.identitystore#DescribeUserResponse": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.identitystore#UserName", "traits": { "smithy.api#documentation": "Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “<>;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in 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": {} } } } }, "com.amazonaws.identitystore#Filter": { "type": "structure", "members": { "AttributePath": { "target": "com.amazonaws.identitystore#AttributePath", "traits": { "smithy.api#documentation": "The attribute path 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 ListGroup
. This filter object provides the attribute name and attribute value to search users or groups.
The identifier for a group in the identity store.
", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.identitystore#GroupDisplayName", "traits": { "smithy.api#documentation": "Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “<>;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A group object, which contains a specified group’s metadata and attributes.
" } }, "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 ]+" } }, "com.amazonaws.identitystore#Groups": { "type": "list", "member": { "target": "com.amazonaws.identitystore#Group" } }, "com.amazonaws.identitystore#IdentityStoreId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 12 }, "smithy.api#pattern": "^d-[0-9a-f]{10}$" } }, "com.amazonaws.identitystore#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#Message" }, "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 processing has failed because of an unknown error, exception or failure with an internal server.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.identitystore#ListGroups": { "type": "operation", "input": { "target": "com.amazonaws.identitystore#ListGroupsRequest" }, "output": { "target": "com.amazonaws.identitystore#ListGroupsResponse" }, "errors": [ { "target": "com.amazonaws.identitystore#AccessDeniedException" }, { "target": "com.amazonaws.identitystore#InternalServerException" }, { "target": "com.amazonaws.identitystore#ResourceNotFoundException" }, { "target": "com.amazonaws.identitystore#ThrottlingException" }, { "target": "com.amazonaws.identitystore#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the attribute name and value of the group that you specified in the search. We only support DisplayName
as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId
and group DisplayName
in the response.
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 which contains number and lower case letters. This value is generated at the time that a new identity store is created.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.identitystore#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request, which is used in the ListUsers
and ListGroups
request to specify how many results to return in one page. The length limit is 50 characters.
The pagination token used for the ListUsers
and ListGroups
APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
A list of Filter
objects, which is used in the ListUsers
and ListGroups
request.
A list of Group
objects in the identity store.
The pagination token used for the ListUsers
and ListGroups
APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
Lists the attribute name and value of the user that you specified in the search. We only support UserName
as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId
and UserName
in the response.
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 which contains number and lower case letters. This value is generated at the time that a new identity store is created.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.identitystore#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned per request, which is used in the ListUsers
and ListGroups
request to specify how many results to return in one page. The length limit is 50 characters.
The pagination token used for the ListUsers
and ListGroups
APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
A list of Filter
objects, which is used in the ListUsers
and ListGroups
request.
A list of User
objects in the identity store.
The pagination token used for the ListUsers
and ListGroups
APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
The type of resource in the Identity Store service, which is an enum object. 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, which 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.
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#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GROUP", "name": "GROUP" }, { "value": "USER", "name": "USER" }, { "value": "IDENTITY_STORE", "name": "IDENTITY_STORE" } ] } }, "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 ]+", "smithy.api#sensitive": {} } }, "com.amazonaws.identitystore#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#Message" }, "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 the principal has crossed the throttling limits of the API operations.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.identitystore#User": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.identitystore#UserName", "traits": { "smithy.api#documentation": "Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “<>;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in 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": {} } } }, "traits": { "smithy.api#documentation": "A user object, which contains a specified user’s metadata and attributes.
" } }, "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#Users": { "type": "list", "member": { "target": "com.amazonaws.identitystore#User" } }, "com.amazonaws.identitystore#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.identitystore#Message" }, "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 failed because it contains a syntax error.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } }