Module Smaws_Client_Identitystore.Types

type nonrec validation_exception_reason =
  1. | KMS_DISABLED
  2. | KMS_INVALID_STATE
  3. | KMS_INVALID_KEY_USAGE
  4. | KMS_INVALID_ARN
type nonrec exception_message = string
type nonrec request_id = string
type nonrec validation_exception = {
  1. reason : validation_exception_reason option;
    (*

    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.

    *)
  2. request_id : request_id option;
    (*

    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.

    *)
  3. message : exception_message option;
}

The request failed because it contains a syntax error.

type nonrec identity_store_id = string
type nonrec resource_id = string
type nonrec user_name = string
type nonrec external_id_issuer = string
type nonrec external_id_identifier = string
type nonrec external_id = {
  1. id : external_id_identifier;
    (*

    The identifier issued to this resource by an external identity provider.

    *)
  2. issuer : external_id_issuer;
    (*

    The issuer for an external identifier.

    *)
}

The identifier issued to this resource by an external identity provider.

type nonrec external_ids = external_id list
type nonrec sensitive_string_type = string
type nonrec name = {
  1. honorific_suffix : sensitive_string_type option;
    (*

    The honorific suffix of the user. For example, "M.D."

    *)
  2. honorific_prefix : sensitive_string_type option;
    (*

    The honorific prefix of the user. For example, "Dr."

    *)
  3. middle_name : sensitive_string_type option;
    (*

    The middle name of the user.

    *)
  4. given_name : sensitive_string_type option;
    (*

    The given name of the user.

    *)
  5. family_name : sensitive_string_type option;
    (*

    The family name of the user.

    *)
  6. formatted : sensitive_string_type option;
    (*

    A string containing a formatted version of the name for display.

    *)
}

The full name of the user.

type nonrec boolean_type = bool
type nonrec email = {
  1. primary : boolean_type option;
    (*

    A Boolean value representing whether this is the primary email address for the associated resource.

    *)
  2. type_ : sensitive_string_type option;
    (*

    A string representing the type of address. For example, "Work."

    *)
  3. value : sensitive_string_type option;
    (*

    A string containing an email address. For example, "johndoe@amazon.com."

    *)
}

The email address associated with the user.

type nonrec emails = email list
type nonrec address = {
  1. primary : boolean_type option;
    (*

    A Boolean value representing whether this is the primary address for the associated resource.

    *)
  2. type_ : sensitive_string_type option;
    (*

    A string representing the type of address. For example, "Home."

    *)
  3. formatted : sensitive_string_type option;
    (*

    A string containing a formatted version of the address for display.

    *)
  4. country : sensitive_string_type option;
    (*

    The country of the address.

    *)
  5. postal_code : sensitive_string_type option;
    (*

    The postal code of the address.

    *)
  6. region : sensitive_string_type option;
    (*

    The region of the address.

    *)
  7. locality : sensitive_string_type option;
    (*

    A string of the address locality.

    *)
  8. street_address : sensitive_string_type option;
    (*

    The street of the address.

    *)
}

The address associated with the specified user.

type nonrec addresses = address list
type nonrec phone_number = {
  1. primary : boolean_type option;
    (*

    A Boolean value representing whether this is the primary phone number for the associated resource.

    *)
  2. type_ : sensitive_string_type option;
    (*

    A string representing the type of a phone number. For example, "Mobile."

    *)
  3. value : sensitive_string_type option;
    (*

    A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

    *)
}

The phone number associated with the user.

type nonrec phone_numbers = phone_number list
type nonrec user_status =
  1. | DISABLED
  2. | ENABLED
type nonrec photo = {
  1. primary : boolean_type option;
    (*

    Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.

    *)
  2. display : sensitive_string_type option;
    (*

    A human-readable description of the photo for display purposes. This optional field provides context about the photo.

    *)
  3. type_ : sensitive_string_type option;
    (*

    The type of photo. This field is optional and can be used to categorize different types of photos.

    *)
  4. value : sensitive_string_type;
    (*

    The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.

    *)
}

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.

type nonrec photos = photo list
type nonrec role = {
  1. primary : boolean_type option;
    (*

    A Boolean value representing whether this is the primary role for the associated resource.

    *)
  2. type_ : sensitive_string_type option;
    (*

    A string representing the type of role. For example, "Work."

    *)
  3. value : sensitive_string_type option;
    (*

    A string containing a role name. For example, "Researcher."

    *)
}

The role associated with the user.

type nonrec roles = role list
type nonrec date_type = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec string_type = string
type nonrec attribute_value = Smaws_Lib.CoreTypes.Document.t
type nonrec extension_name = string
type nonrec extensions = (extension_name * attribute_value) list
type nonrec user = {
  1. extensions : extensions option;
    (*

    A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.

    *)
  2. updated_by : string_type option;
    (*

    The identifier of the user or system that last updated the user.

    *)
  3. updated_at : date_type option;
    (*

    The date and time the user was last updated.

    *)
  4. created_by : string_type option;
    (*

    The identifier of the user or system that created the user.

    *)
  5. created_at : date_type option;
    (*

    The date and time the user was created.

    *)
  6. roles : roles option;
    (*

    A list of Role objects containing roles associated with the user.

    *)
  7. birthdate : sensitive_string_type option;
    (*

    The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

    *)
  8. website : sensitive_string_type option;
    (*

    The user's personal website or blog URL. This field stores website information for personal or professional use.

    *)
  9. photos : photos option;
    (*

    A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

    *)
  10. user_status : user_status option;
    (*

    The current status of the user account.

    *)
  11. timezone : sensitive_string_type option;
    (*

    A string containing the time zone of the user.

    *)
  12. locale : sensitive_string_type option;
    (*

    A string containing the geographical region or location of the user.

    *)
  13. preferred_language : sensitive_string_type option;
    (*

    A string containing the preferred language of the user. For example, "American English" or "en-us."

    *)
  14. title : sensitive_string_type option;
    (*

    A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

    *)
  15. user_type : sensitive_string_type option;
    (*

    A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

    *)
  16. phone_numbers : phone_numbers option;
    (*

    A list of PhoneNumber objects containing phone numbers associated with the user.

    *)
  17. addresses : addresses option;
    (*

    A list of Address objects containing addresses associated with the user.

    *)
  18. emails : emails option;
    (*

    A list of Email objects containing email addresses associated with the user.

    *)
  19. profile_url : sensitive_string_type option;
    (*

    A string containing a URL that might be associated with the user.

    *)
  20. nick_name : sensitive_string_type option;
    (*

    A string containing an alternate name for the user.

    *)
  21. display_name : sensitive_string_type option;
    (*

    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.

    *)
  22. name : name option;
    (*

    An object containing the name of the user.

    *)
  23. external_ids : external_ids option;
    (*

    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

    *)
  24. user_name : user_name option;
    (*

    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.

    *)
  25. user_id : resource_id;
    (*

    The identifier for a user in the identity store.

    *)
  26. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}

A user object that contains the metadata and attributes for a specified user.

type nonrec users = user list
type nonrec user_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec update_user_response = unit
type nonrec attribute_path = string
type nonrec attribute_operation = {
  1. attribute_value : attribute_value option;
    (*

    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.

    *)
  2. attribute_path : attribute_path;
    (*

    A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

    *)
}

An operation that applies to the requested group. This operation might add, replace, or remove an attribute.

type nonrec attribute_operations = attribute_operation list
type nonrec update_user_request = {
  1. operations : attribute_operations;
    (*

    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.

    *)
  2. user_id : resource_id;
    (*

    The identifier for a user in the identity store.

    *)
  3. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec service_quota_exceeded_exception = {
  1. request_id : request_id option;
    (*

    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.

    *)
  2. message : exception_message option;
}

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

type nonrec resource_type =
  1. | RESOURCE_POLICY
  2. | GROUP_MEMBERSHIP
  3. | IDENTITY_STORE
  4. | USER
  5. | GROUP
type nonrec resource_not_found_exception_reason =
  1. | KMS_KEY_NOT_FOUND
type nonrec resource_not_found_exception = {
  1. request_id : request_id option;
    (*

    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.

    *)
  2. message : exception_message option;
  3. reason : resource_not_found_exception_reason option;
    (*

    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.

    *)
  4. resource_id : resource_id option;
    (*

    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.

    *)
  5. resource_type : resource_type option;
    (*

    An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.

    *)
}

Indicates that a requested resource is not found.

type nonrec conflict_exception_reason =
  1. | CONCURRENT_MODIFICATION
  2. | UNIQUENESS_CONSTRAINT_VIOLATION
type nonrec conflict_exception = {
  1. reason : conflict_exception_reason option;
    (*

    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.

    *)
  2. request_id : request_id option;
    (*

    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.

    *)
  3. message : exception_message option;
}

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.
type nonrec update_group_response = unit
type nonrec update_group_request = {
  1. operations : attribute_operations;
    (*

    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.

    *)
  2. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  3. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec unique_attribute = {
  1. attribute_value : attribute_value;
    (*

    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.

    *)
  2. attribute_path : attribute_path;
    (*

    A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

    *)
}

An entity attribute that's unique to a specific entity.

type nonrec throttling_exception_reason =
  1. | KMS_THROTTLING
type nonrec retry_after_seconds = int
type nonrec throttling_exception = {
  1. reason : throttling_exception_reason option;
    (*

    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.

    *)
  2. retry_after_seconds : retry_after_seconds option;
    (*

    The number of seconds to wait before retrying the next request.

    *)
  3. request_id : request_id option;
    (*

    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.

    *)
  4. message : exception_message option;
}

Indicates that the principal has crossed the throttling limits of the API operations.

type nonrec next_token = string
type nonrec member_id =
  1. | UserId of resource_id
    (*

    An object containing the identifiers of resources that can be members.

    *)

An object containing the identifier of a group member.

type nonrec max_results = int
type nonrec list_users_response = {
  1. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  2. users : users;
    (*

    A list of User objects in the identity store.

    *)
}
type nonrec extension_names = extension_name list
type nonrec filter = {
  1. attribute_value : sensitive_string_type;
    (*

    Represents the data for an attribute. Each attribute value is described as a name-value pair.

    *)
  2. attribute_path : attribute_path;
    (*

    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.

    *)
}

A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.

type nonrec filters = filter list
type nonrec list_users_request = {
  1. filters : filters option;
    (*

    A list of Filter objects, which is used in the ListUsers and ListGroups requests.

    *)
  2. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  3. max_results : max_results option;
    (*

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

    *)
  4. extensions : extension_names option;
    (*

    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.

    *)
  5. identity_store_id : identity_store_id;
    (*

    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.

    *)
}
type nonrec group_display_name = string
type nonrec group = {
  1. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
  2. updated_by : string_type option;
    (*

    The identifier of the user or system that last updated the group.

    *)
  3. created_by : string_type option;
    (*

    The identifier of the user or system that created the group.

    *)
  4. updated_at : date_type option;
    (*

    The date and time the group was last updated.

    *)
  5. created_at : date_type option;
    (*

    The date and time the group was created.

    *)
  6. description : sensitive_string_type option;
    (*

    A string containing a description of the specified group.

    *)
  7. external_ids : external_ids option;
    (*

    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

    *)
  8. display_name : group_display_name option;
    (*

    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.

    *)
  9. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
}

A group object that contains the metadata and attributes for a specified group.

type nonrec groups = group list
type nonrec list_groups_response = {
  1. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  2. groups : groups;
    (*

    A list of Group objects in the identity store.

    *)
}
type nonrec list_groups_request = {
  1. filters : filters option;
    (*

    A list of Filter objects, which is used in the ListUsers and ListGroups requests.

    *)
  2. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  3. max_results : max_results option;
    (*

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

    *)
  4. identity_store_id : identity_store_id;
    (*

    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.

    *)
}
type nonrec group_membership = {
  1. updated_by : string_type option;
    (*

    The identifier of the user or system that last updated the group membership.

    *)
  2. created_by : string_type option;
    (*

    The identifier of the user or system that created the group membership.

    *)
  3. updated_at : date_type option;
    (*

    The date and time the group membership was last updated.

    *)
  4. created_at : date_type option;
    (*

    The date and time the group membership was created.

    *)
  5. member_id : member_id option;
    (*

    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.

    *)
  6. group_id : resource_id option;
    (*

    The identifier for a group in the identity store.

    *)
  7. membership_id : resource_id option;
    (*

    The identifier for a GroupMembership object in an identity store.

    *)
  8. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}

Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.

type nonrec group_memberships = group_membership list
type nonrec list_group_memberships_response = {
  1. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  2. group_memberships : group_memberships;
    (*

    A list of GroupMembership objects in the group.

    *)
}
type nonrec list_group_memberships_request = {
  1. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  2. max_results : max_results option;
    (*

    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.

    *)
  3. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  4. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec list_group_memberships_for_member_response = {
  1. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  2. group_memberships : group_memberships;
    (*

    A list of GroupMembership objects in the group for a specified member.

    *)
}
type nonrec list_group_memberships_for_member_request = {
  1. next_token : next_token option;
    (*

    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 search for the next page.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

    *)
  3. member_id : member_id;
    (*

    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.

    *)
  4. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec group_membership_existence_result = {
  1. membership_exists : boolean_type option;
    (*

    Indicates whether a membership relation exists or not.

    *)
  2. member_id : member_id option;
    (*

    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.

    *)
  3. group_id : resource_id option;
    (*

    The identifier for a group in the identity store.

    *)
}

Indicates whether a resource is a member of a group in the identity store.

type nonrec group_membership_existence_results = group_membership_existence_result list
type nonrec is_member_in_groups_response = {
  1. results : group_membership_existence_results;
    (*

    A list containing the results of membership existence checks.

    *)
}
type nonrec group_ids = resource_id list
type nonrec is_member_in_groups_request = {
  1. group_ids : group_ids;
    (*

    A list of identifiers for groups in the identity store.

    *)
  2. member_id : member_id;
    (*

    An object containing the identifier of a group member.

    *)
  3. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec internal_server_exception = {
  1. retry_after_seconds : retry_after_seconds option;
    (*

    The number of seconds to wait before retrying the next request.

    *)
  2. request_id : request_id option;
    (*

    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.

    *)
  3. message : exception_message option;
}

The request processing has failed because of an unknown error, exception or failure with an internal server.

type nonrec group_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec group_membership_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec get_user_id_response = {
  1. user_id : resource_id;
    (*

    The identifier for a user in the identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec alternate_identifier =
  1. | UniqueAttribute of unique_attribute
    (*

    An entity attribute that's unique to a specific entity.

    *)
  2. | ExternalId of external_id
    (*

    The identifier issued to this resource by an external identity provider.

    *)

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.

type nonrec get_user_id_request = {
  1. alternate_identifier : alternate_identifier;
    (*

    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.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec get_group_membership_id_response = {
  1. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
  2. membership_id : resource_id;
    (*

    The identifier for a GroupMembership in an identity store.

    *)
}
type nonrec get_group_membership_id_request = {
  1. member_id : member_id;
    (*

    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.

    *)
  2. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  3. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec get_group_id_response = {
  1. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
  2. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
}
type nonrec get_group_id_request = {
  1. alternate_identifier : alternate_identifier;
    (*

    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.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec describe_user_response = {
  1. extensions : extensions option;
    (*

    A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.

    *)
  2. updated_by : string_type option;
    (*

    The identifier of the user or system that last updated the user.

    *)
  3. updated_at : date_type option;
    (*

    The date and time the user was last updated.

    *)
  4. created_by : string_type option;
    (*

    The identifier of the user or system that created the user.

    *)
  5. created_at : date_type option;
    (*

    The date and time the user was created.

    *)
  6. roles : roles option;
    (*

    The roles of the user.

    *)
  7. birthdate : sensitive_string_type option;
    (*

    The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.

    *)
  8. website : sensitive_string_type option;
    (*

    The user's personal website or blog URL. Returns the stored website information for the user.

    *)
  9. photos : photos option;
    (*

    A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

    *)
  10. user_status : user_status option;
    (*

    The current status of the user account.

    *)
  11. timezone : sensitive_string_type option;
    (*

    The time zone for a user.

    *)
  12. locale : sensitive_string_type option;
    (*

    A string containing the geographical region or location of the user.

    *)
  13. preferred_language : sensitive_string_type option;
    (*

    The preferred language of the user.

    *)
  14. title : sensitive_string_type option;
    (*

    A string containing the title of the user.

    *)
  15. user_type : sensitive_string_type option;
    (*

    A string indicating the type of user.

    *)
  16. phone_numbers : phone_numbers option;
    (*

    A list of PhoneNumber objects associated with a user.

    *)
  17. addresses : addresses option;
    (*

    The physical address of the user.

    *)
  18. emails : emails option;
    (*

    The email address of the user.

    *)
  19. profile_url : sensitive_string_type option;
    (*

    A URL link for the user's profile.

    *)
  20. nick_name : sensitive_string_type option;
    (*

    An alternative descriptive name for the user.

    *)
  21. display_name : sensitive_string_type option;
    (*

    The display name of the user.

    *)
  22. name : name option;
    (*

    The name of the user.

    *)
  23. external_ids : external_ids option;
    (*

    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

    *)
  24. user_name : user_name option;
    (*

    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.

    *)
  25. user_id : resource_id;
    (*

    The identifier for a user in the identity store.

    *)
  26. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec describe_user_request = {
  1. extensions : extension_names option;
    (*

    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.

    *)
  2. user_id : resource_id;
    (*

    The identifier for a user in the identity store.

    *)
  3. identity_store_id : identity_store_id;
    (*

    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.

    *)
}
type nonrec describe_group_response = {
  1. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
  2. updated_by : string_type option;
    (*

    The identifier of the user or system that last updated the group.

    *)
  3. created_by : string_type option;
    (*

    The identifier of the user or system that created the group.

    *)
  4. updated_at : date_type option;
    (*

    The date and time the group was last updated.

    *)
  5. created_at : date_type option;
    (*

    The date and time the group was created.

    *)
  6. description : sensitive_string_type option;
    (*

    A string containing a description of the group.

    *)
  7. external_ids : external_ids option;
    (*

    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

    *)
  8. display_name : group_display_name option;
    (*

    The group’s 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.

    *)
  9. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
}
type nonrec describe_group_request = {
  1. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    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.

    *)
}
type nonrec describe_group_membership_response = {
  1. updated_by : string_type option;
    (*

    The identifier of the user or system that last updated the group membership.

    *)
  2. created_by : string_type option;
    (*

    The identifier of the user or system that created the group membership.

    *)
  3. updated_at : date_type option;
    (*

    The date and time the group membership was last updated.

    *)
  4. created_at : date_type option;
    (*

    The date and time the group membership was created.

    *)
  5. member_id : member_id;
  6. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  7. membership_id : resource_id;
    (*

    The identifier for a GroupMembership in an identity store.

    *)
  8. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec describe_group_membership_request = {
  1. membership_id : resource_id;
    (*

    The identifier for a GroupMembership in an identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec delete_user_response = unit
type nonrec delete_user_request = {
  1. user_id : resource_id;
    (*

    The identifier for a user in the identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec delete_group_response = unit
type nonrec delete_group_request = {
  1. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec delete_group_membership_response = unit
type nonrec delete_group_membership_request = {
  1. membership_id : resource_id;
    (*

    The identifier for a GroupMembership in an identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec create_user_response = {
  1. user_id : resource_id;
    (*

    The identifier of the newly created user in the identity store.

    *)
  2. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec create_user_request = {
  1. extensions : extensions option;
    (*

    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.

    *)
  2. roles : roles option;
    (*

    A list of Role objects containing roles associated with the user.

    *)
  3. birthdate : sensitive_string_type option;
    (*

    The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.

    *)
  4. website : sensitive_string_type option;
    (*

    The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.

    *)
  5. photos : photos option;
    (*

    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.

    *)
  6. timezone : sensitive_string_type option;
    (*

    A string containing the time zone of the user.

    *)
  7. locale : sensitive_string_type option;
    (*

    A string containing the geographical region or location of the user.

    *)
  8. preferred_language : sensitive_string_type option;
    (*

    A string containing the preferred language of the user. For example, "American English" or "en-us."

    *)
  9. title : sensitive_string_type option;
    (*

    A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

    *)
  10. user_type : sensitive_string_type option;
    (*

    A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

    *)
  11. phone_numbers : phone_numbers option;
    (*

    A list of PhoneNumber objects containing phone numbers associated with the user.

    *)
  12. addresses : addresses option;
    (*

    A list of Address objects containing addresses associated with the user.

    *)
  13. emails : emails option;
    (*

    A list of Email objects containing email addresses associated with the user.

    *)
  14. profile_url : sensitive_string_type option;
    (*

    A string containing a URL that might be associated with the user.

    *)
  15. nick_name : sensitive_string_type option;
    (*

    A string containing an alternate name for the user.

    *)
  16. display_name : sensitive_string_type option;
    (*

    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.

    *)
  17. name : name option;
    (*

    An object containing the name of the user. When used in IAM Identity Center, this parameter is required.

    *)
  18. user_name : user_name option;
    (*

    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.

    *)
  19. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec create_group_response = {
  1. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
  2. group_id : resource_id;
    (*

    The identifier of the newly created group in the identity store.

    *)
}
type nonrec create_group_request = {
  1. description : sensitive_string_type option;
    (*

    A string containing the description of the group.

    *)
  2. display_name : group_display_name option;
    (*

    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.

    *)
  3. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec create_group_membership_response = {
  1. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
  2. membership_id : resource_id;
    (*

    The identifier for a newly created GroupMembership in an identity store.

    *)
}
type nonrec create_group_membership_request = {
  1. member_id : member_id;
    (*

    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.

    *)
  2. group_id : resource_id;
    (*

    The identifier for a group in the identity store.

    *)
  3. identity_store_id : identity_store_id;
    (*

    The globally unique identifier for the identity store.

    *)
}
type nonrec access_denied_exception_reason =
  1. | KMS_ACCESS_DENIED
type nonrec access_denied_exception = {
  1. reason : access_denied_exception_reason option;
    (*

    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.

    *)
  2. request_id : request_id option;
    (*

    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.

    *)
  3. message : exception_message option;
}

You do not have sufficient access to perform this action.