Skip to content

Identitystore Classes

AddressTypeDef

StreetAddress

  • Type: typing.Optional[str]

Locality

  • Type: typing.Optional[str]

Region

  • Type: typing.Optional[str]

PostalCode

  • Type: typing.Optional[str]

Country

  • Type: typing.Optional[str]

Formatted

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[str]

Primary

  • Type: typing.Optional[bool]

AlternateIdentifierTypeDef

ExternalId

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.ExternalIdTypeDef]

UniqueAttribute

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.UniqueAttributeTypeDef]

AttributeOperationTypeDef

AttributePath

  • Type:
  • Required: Yes

AttributeValue

  • Type: typing.Optional[typing.Mapping[str, typing.Any]]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CreateGroupMembershipRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

CreateGroupMembershipResponseTypeDef

MembershipId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateGroupRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

DisplayName

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

CreateGroupResponseTypeDef

GroupId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

UserName

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.NameTypeDef]

DisplayName

  • Type: typing.Optional[str]

NickName

  • Type: typing.Optional[str]

ProfileUrl

  • Type: typing.Optional[str]

Emails

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.EmailTypeDef]]

Addresses

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.AddressTypeDef]]

PhoneNumbers

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.PhoneNumberTypeDef]]

UserType

  • Type: typing.Optional[str]

Title

  • Type: typing.Optional[str]

PreferredLanguage

  • Type: typing.Optional[str]

Locale

  • Type: typing.Optional[str]

Timezone

  • Type: typing.Optional[str]

CreateUserResponseTypeDef

UserId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteGroupMembershipRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type:
  • Required: Yes

DeleteGroupRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

DeleteUserRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

DescribeGroupMembershipRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type:
  • Required: Yes

DescribeGroupMembershipResponseTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeGroupRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

DescribeGroupResponseTypeDef

GroupId

  • Type:
  • Required: Yes

DisplayName

  • Type:
  • Required: Yes

ExternalIds

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.ExternalIdTypeDef]
  • Required: Yes

Description

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeUserRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

DescribeUserResponseTypeDef

UserName

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

ExternalIds

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.ExternalIdTypeDef]
  • Required: Yes

Name

  • Type:
  • Required: Yes

DisplayName

  • Type:
  • Required: Yes

NickName

  • Type:
  • Required: Yes

ProfileUrl

  • Type:
  • Required: Yes

Emails

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.EmailTypeDef]
  • Required: Yes

Addresses

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.AddressTypeDef]
  • Required: Yes

PhoneNumbers

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.PhoneNumberTypeDef]
  • Required: Yes

UserType

  • Type:
  • Required: Yes

Title

  • Type:
  • Required: Yes

PreferredLanguage

  • Type:
  • Required: Yes

Locale

  • Type:
  • Required: Yes

Timezone

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EmailTypeDef

Value

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[str]

Primary

  • Type: typing.Optional[bool]

ExternalIdTypeDef

Issuer

  • Type:
  • Required: Yes

Id

  • Type:
  • Required: Yes

FilterTypeDef

AttributePath

  • Type:
  • Required: Yes

AttributeValue

  • Type:
  • Required: Yes

GetGroupIdRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

AlternateIdentifier

  • Type:
  • Required: Yes

GetGroupIdResponseTypeDef

GroupId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGroupMembershipIdRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

GetGroupMembershipIdResponseTypeDef

MembershipId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserIdRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

AlternateIdentifier

  • Type:
  • Required: Yes

GetUserIdResponseTypeDef

UserId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GroupMembershipExistenceResultTypeDef

GroupId

  • Type: typing.Optional[str]

MemberId

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.MemberIdTypeDef]

MembershipExists

  • Type: typing.Optional[bool]

GroupMembershipTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type: typing.Optional[str]

GroupId

  • Type: typing.Optional[str]

MemberId

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.MemberIdTypeDef]

GroupTypeDef

GroupId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

DisplayName

  • Type: typing.Optional[str]

ExternalIds

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.identitystore_classes.ExternalIdTypeDef]]

Description

  • Type: typing.Optional[str]

IsMemberInGroupsRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

GroupIds

  • Type: typing.Sequence[str]
  • Required: Yes

IsMemberInGroupsResponseTypeDef

Results

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.GroupMembershipExistenceResultTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.PaginatorConfigTypeDef]

ListGroupMembershipsForMemberRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGroupMembershipsForMemberResponseTypeDef

GroupMemberships

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.GroupMembershipTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.PaginatorConfigTypeDef]

ListGroupMembershipsRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGroupMembershipsResponseTypeDef

GroupMemberships

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.GroupMembershipTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupsRequestListGroupsPaginateTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.FilterTypeDef]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.PaginatorConfigTypeDef]

ListGroupsRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.FilterTypeDef]]

ListGroupsResponseTypeDef

Groups

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.GroupTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListUsersRequestListUsersPaginateTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.FilterTypeDef]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.PaginatorConfigTypeDef]

ListUsersRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

Filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.FilterTypeDef]]

ListUsersResponseTypeDef

Users

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore_classes.UserTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MemberIdTypeDef

UserId

  • Type: typing.Optional[str]

NameTypeDef

Formatted

  • Type: typing.Optional[str]

FamilyName

  • Type: typing.Optional[str]

GivenName

  • Type: typing.Optional[str]

MiddleName

  • Type: typing.Optional[str]

HonorificPrefix

  • Type: typing.Optional[str]

HonorificSuffix

  • Type: typing.Optional[str]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PhoneNumberTypeDef

Value

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[str]

Primary

  • Type: typing.Optional[bool]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

UniqueAttributeTypeDef

AttributePath

  • Type:
  • Required: Yes

AttributeValue

  • Type: typing.Mapping[str, typing.Any]
  • Required: Yes

UpdateGroupRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

Operations

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.AttributeOperationTypeDef]
  • Required: Yes

UpdateUserRequestRequestTypeDef

IdentityStoreId

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

Operations

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.identitystore_classes.AttributeOperationTypeDef]
  • Required: Yes

UserTypeDef

UserId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

UserName

  • Type: typing.Optional[str]

ExternalIds

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.identitystore_classes.ExternalIdTypeDef]]

Name

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore_classes.NameTypeDef]

DisplayName

  • Type: typing.Optional[str]

NickName

  • Type: typing.Optional[str]

ProfileUrl

  • Type: typing.Optional[str]

Emails

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.identitystore_classes.EmailTypeDef]]

Addresses

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.identitystore_classes.AddressTypeDef]]

PhoneNumbers

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.identitystore_classes.PhoneNumberTypeDef]]

UserType

  • Type: typing.Optional[str]

Title

  • Type: typing.Optional[str]

PreferredLanguage

  • Type: typing.Optional[str]

Locale

  • Type: typing.Optional[str]

Timezone

  • Type: typing.Optional[str]