Skip to content

Identitystore Classes

Address

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]

AlternateIdentifier

ExternalId

  • Type:

UniqueAttribute

  • Type:

AttributeOperation

AttributePath

  • Type:
  • Required: Yes

AttributeValue

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

BaseValidatorModel

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

CreateGroupMembershipRequest

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

CreateGroupMembershipResponse

MembershipId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateGroupRequest

IdentityStoreId

  • Type:
  • Required: Yes

DisplayName

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

CreateGroupResponse

GroupId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserRequest

IdentityStoreId

  • Type:
  • Required: Yes

UserName

  • Type: typing.Optional[str]

Name

  • Type:

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.identitystore_classes.Email]]

Addresses

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

PhoneNumbers

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

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]

CreateUserResponse

UserId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteGroupMembershipRequest

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type:
  • Required: Yes

DeleteGroupRequest

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

DeleteUserRequest

IdentityStoreId

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

DescribeGroupMembershipRequest

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type:
  • Required: Yes

DescribeGroupMembershipResponse

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeGroupRequest

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

DescribeGroupResponse

GroupId

  • Type:
  • Required: Yes

DisplayName

  • Type:
  • Required: Yes

ExternalIds

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

Description

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeUserRequest

IdentityStoreId

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

DescribeUserResponse

UserName

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

ExternalIds

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore.identitystore_classes.ExternalId]
  • 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.identitystore_classes.Email]
  • Required: Yes

Addresses

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

PhoneNumbers

  • Type: typing.List[aws_resource_validator.pydantic_models.identitystore.identitystore_classes.PhoneNumber]
  • 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

Email

Value

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[str]

Primary

  • Type: typing.Optional[bool]

ExternalId

Issuer

  • Type:
  • Required: Yes

Id

  • Type:
  • Required: Yes

Filter

AttributePath

  • Type:
  • Required: Yes

AttributeValue

  • Type:
  • Required: Yes

GetGroupIdRequest

IdentityStoreId

  • Type:
  • Required: Yes

AlternateIdentifier

  • Type:
  • Required: Yes

GetGroupIdResponse

GroupId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGroupMembershipIdRequest

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

GetGroupMembershipIdResponse

MembershipId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserIdRequest

IdentityStoreId

  • Type:
  • Required: Yes

AlternateIdentifier

  • Type:
  • Required: Yes

GetUserIdResponse

UserId

  • Type:
  • Required: Yes

IdentityStoreId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Group

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.identitystore_classes.ExternalId]]

Description

  • Type: typing.Optional[str]

GroupMembership

IdentityStoreId

  • Type:
  • Required: Yes

MembershipId

  • Type: typing.Optional[str]

GroupId

  • Type: typing.Optional[str]

MemberId

  • Type:

GroupMembershipExistenceResult

GroupId

  • Type: typing.Optional[str]

MemberId

  • Type:

MembershipExists

  • Type: typing.Optional[bool]

IsMemberInGroupsRequest

IdentityStoreId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

GroupIds

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

IsMemberInGroupsResponse

Results

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

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupMembershipsForMemberRequest

IdentityStoreId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGroupMembershipsForMemberRequestPaginate

IdentityStoreId

  • Type:
  • Required: Yes

MemberId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore.identitystore_classes.PaginatorConfig]

ListGroupMembershipsForMemberResponse

GroupMemberships

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListGroupMembershipsRequest

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGroupMembershipsRequestPaginate

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore.identitystore_classes.PaginatorConfig]

ListGroupMembershipsResponse

GroupMemberships

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListGroupsRequest

IdentityStoreId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

Filters

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

ListGroupsRequestPaginate

IdentityStoreId

  • Type:
  • Required: Yes

Filters

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

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore.identitystore_classes.PaginatorConfig]

ListGroupsResponse

Groups

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListUsersRequest

IdentityStoreId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

Filters

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

ListUsersRequestPaginate

IdentityStoreId

  • Type:
  • Required: Yes

Filters

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

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.identitystore.identitystore_classes.PaginatorConfig]

ListUsersResponse

Users

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MemberId

UserId

  • Type: typing.Optional[str]

Name

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]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PhoneNumber

Value

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[str]

Primary

  • Type: typing.Optional[bool]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

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

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

UniqueAttribute

AttributePath

  • Type:
  • Required: Yes

AttributeValue

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

UpdateGroupRequest

IdentityStoreId

  • Type:
  • Required: Yes

GroupId

  • Type:
  • Required: Yes

Operations

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

UpdateUserRequest

IdentityStoreId

  • Type:
  • Required: Yes

UserId

  • Type:
  • Required: Yes

Operations

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

User

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.identitystore_classes.ExternalId]]

Name

  • Type:

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.identitystore_classes.Email]]

Addresses

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

PhoneNumbers

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

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]