| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IdentityStore
Description
Derived from API version 2020-06-15 of the AWS service descriptions, licensed under Apache 2.0.
The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your identities (users and groups). For more information about AWS, see the AWS Single Sign-On User Guide.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data DescribeGroup = DescribeGroup' Text Text
- newDescribeGroup :: Text -> Text -> DescribeGroup
- data DescribeGroupResponse = DescribeGroupResponse' Int Text Text
- newDescribeGroupResponse :: Int -> Text -> Text -> DescribeGroupResponse
- data ListUsers = ListUsers' (Maybe [Filter]) (Maybe Text) (Maybe Natural) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) Int [User]
- newListUsersResponse :: Int -> ListUsersResponse
- data DescribeUser = DescribeUser' Text Text
- newDescribeUser :: Text -> Text -> DescribeUser
- data DescribeUserResponse = DescribeUserResponse' Int (Sensitive Text) Text
- newDescribeUserResponse :: Int -> Text -> Text -> DescribeUserResponse
- data ListGroups = ListGroups' (Maybe [Filter]) (Maybe Text) (Maybe Natural) Text
- newListGroups :: Text -> ListGroups
- data ListGroupsResponse = ListGroupsResponse' (Maybe Text) Int [Group]
- newListGroupsResponse :: Int -> ListGroupsResponse
- data Filter = Filter' Text (Sensitive Text)
- newFilter :: Text -> Text -> Filter
- data Group = Group' Text Text
- newGroup :: Text -> Text -> Group
- data User = User' (Sensitive Text) Text
- newUser :: Text -> Text -> User
Service Configuration
defaultService :: Service Source #
API version 2020-06-15 of the Amazon SSO Identity Store SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IdentityStore.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because it contains a syntax error.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the principal has crossed the throttling limits of the API operations.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure with an internal server.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a requested resource is not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeGroup
data DescribeGroup Source #
See: newDescribeGroup smart constructor.
Constructors
| DescribeGroup' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeGroup |
Create a value of DescribeGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityStoreId:DescribeGroup', describeGroup_identityStoreId - 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 number and
lower case letters. This value is generated at the time that a new
identity store is created.
$sel:groupId:DescribeGroup', describeGroup_groupId - The identifier for a group in the identity store.
data DescribeGroupResponse Source #
See: newDescribeGroupResponse smart constructor.
Constructors
| DescribeGroupResponse' Int Text Text |
Instances
newDescribeGroupResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> DescribeGroupResponse |
Create a value of DescribeGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeGroupResponse', describeGroupResponse_httpStatus - The response's http status code.
$sel:groupId:DescribeGroup', describeGroupResponse_groupId - The identifier for a group in the identity store.
$sel:displayName:DescribeGroupResponse', describeGroupResponse_displayName - Contains 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. The characters <>;:% are
excluded. 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.
ListUsers
See: newListUsers smart constructor.
Instances
Create a value of ListUsers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListUsers', listUsers_filters - A list of Filter objects, which is used in the ListUsers and
ListGroups request.
$sel:nextToken:ListUsers', listUsers_nextToken - 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.
$sel:maxResults:ListUsers', listUsers_maxResults - The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups request to specify how many
results to return in one page. The length limit is 50 characters.
$sel:identityStoreId:ListUsers', listUsers_identityStoreId - 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 number and
lower case letters. This value is generated at the time that a new
identity store is created.
data ListUsersResponse Source #
See: newListUsersResponse smart constructor.
Constructors
| ListUsersResponse' (Maybe Text) Int [User] |
Instances
Arguments
| :: Int | |
| -> ListUsersResponse |
Create a value of ListUsersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListUsers', listUsersResponse_nextToken - 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.
$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.
$sel:users:ListUsersResponse', listUsersResponse_users - A list of User objects in the identity store.
DescribeUser
data DescribeUser Source #
See: newDescribeUser smart constructor.
Constructors
| DescribeUser' Text Text |
Instances
Create a value of DescribeUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityStoreId:DescribeUser', describeUser_identityStoreId - 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 number and
lower case letters. This value is generated at the time that a new
identity store is created.
$sel:userId:DescribeUser', describeUser_userId - The identifier for a user in the identity store.
data DescribeUserResponse Source #
See: newDescribeUserResponse smart constructor.
Constructors
| DescribeUserResponse' Int (Sensitive Text) Text |
Instances
newDescribeUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> DescribeUserResponse |
Create a value of DescribeUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.
$sel:userName:DescribeUserResponse', describeUserResponse_userName - Contains the user’s user name 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.
$sel:userId:DescribeUser', describeUserResponse_userId - The identifier for a user in the identity store.
ListGroups
data ListGroups Source #
See: newListGroups smart constructor.
Instances
Arguments
| :: Text | |
| -> ListGroups |
Create a value of ListGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListGroups', listGroups_filters - A list of Filter objects, which is used in the ListUsers and
ListGroups request.
$sel:nextToken:ListGroups', listGroups_nextToken - 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.
$sel:maxResults:ListGroups', listGroups_maxResults - The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups request to specify how many
results to return in one page. The length limit is 50 characters.
$sel:identityStoreId:ListGroups', listGroups_identityStoreId - 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 number and
lower case letters. This value is generated at the time that a new
identity store is created.
data ListGroupsResponse Source #
See: newListGroupsResponse smart constructor.
Constructors
| ListGroupsResponse' (Maybe Text) Int [Group] |
Instances
newListGroupsResponse Source #
Arguments
| :: Int | |
| -> ListGroupsResponse |
Create a value of ListGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListGroups', listGroupsResponse_nextToken - 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 it1 is used in the API
request to search for the next page.
$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.
$sel:groups:ListGroupsResponse', listGroupsResponse_groups - A list of Group objects in the identity store.
Types
Filter
A query filter used by ListUsers and ListGroup. This filter object
provides the attribute name and attribute value to search users or
groups.
See: newFilter smart constructor.
Instances
| Eq Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter | |
| ToJSON Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.IdentityStore.Types.Filter" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributePath:Filter', filter_attributePath - 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.
$sel:attributeValue:Filter', filter_attributeValue - Represents the data for an attribute. Each attribute value is described
as a name-value pair.
Group
A group object, which contains a specified group’s metadata and attributes.
See: newGroup smart constructor.
Instances
| Eq Group Source # | |
| Read Group Source # | |
| Show Group Source # | |
| Generic Group Source # | |
| NFData Group Source # | |
Defined in Amazonka.IdentityStore.Types.Group | |
| Hashable Group Source # | |
Defined in Amazonka.IdentityStore.Types.Group | |
| FromJSON Group Source # | |
| type Rep Group Source # | |
Defined in Amazonka.IdentityStore.Types.Group type Rep Group = D1 ('MetaData "Group" "Amazonka.IdentityStore.Types.Group" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "Group'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Group with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupId:Group', group_groupId - The identifier for a group in the identity store.
$sel:displayName:Group', group_displayName - Contains 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. 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.
User
A user object, which contains a specified user’s metadata and attributes.
See: newUser smart constructor.
Instances
| Eq User Source # | |
| Show User Source # | |
| Generic User Source # | |
| NFData User Source # | |
Defined in Amazonka.IdentityStore.Types.User | |
| Hashable User Source # | |
Defined in Amazonka.IdentityStore.Types.User | |
| FromJSON User Source # | |
| type Rep User Source # | |
Defined in Amazonka.IdentityStore.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.IdentityStore.Types.User" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of User with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userName:User', user_userName - Contains the user’s user name 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.
$sel:userId:User', user_userId - The identifier for a user in the identity store.