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.AppStream.DescribeUserStackAssociations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

The stack name
The user name (email address of the user associated with the stack) and the authentication type for the user

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeUserStackAssociations Source #

See: newDescribeUserStackAssociations smart constructor.

Constructors

DescribeUserStackAssociations'

Fields

userName :: Maybe (Sensitive Text)
The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
nextToken :: Maybe Text
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
authenticationType :: Maybe AuthenticationType
The authentication type for the user who is associated with the stack. You must specify USERPOOL.
maxResults :: Maybe Natural
The maximum size of each page of results.
stackName :: Maybe Text
The name of the stack that is associated with the user.

Instances

Instances details

Eq DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods (==) :: DescribeUserStackAssociations -> DescribeUserStackAssociations -> Bool # (/=) :: DescribeUserStackAssociations -> DescribeUserStackAssociations -> Bool #
Show DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods showsPrec :: Int -> DescribeUserStackAssociations -> ShowS # show :: DescribeUserStackAssociations -> String # showList :: [DescribeUserStackAssociations] -> ShowS #
Generic DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Associated Types type Rep DescribeUserStackAssociations :: Type -> Type # Methods from :: DescribeUserStackAssociations -> Rep DescribeUserStackAssociations x # to :: Rep DescribeUserStackAssociations x -> DescribeUserStackAssociations #
NFData DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods rnf :: DescribeUserStackAssociations -> () #
Hashable DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods hashWithSalt :: Int -> DescribeUserStackAssociations -> Int # hash :: DescribeUserStackAssociations -> Int #
ToJSON DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods toJSON :: DescribeUserStackAssociations -> Value # toEncoding :: DescribeUserStackAssociations -> Encoding # toJSONList :: [DescribeUserStackAssociations] -> Value # toEncodingList :: [DescribeUserStackAssociations] -> Encoding #
AWSPager DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods page :: DescribeUserStackAssociations -> AWSResponse DescribeUserStackAssociations -> Maybe DescribeUserStackAssociations #
AWSRequest DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Associated Types type AWSResponse DescribeUserStackAssociations # Methods request :: DescribeUserStackAssociations -> Request DescribeUserStackAssociations # response :: MonadResource m => Logger -> Service -> Proxy DescribeUserStackAssociations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUserStackAssociations))) #
ToHeaders DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods toHeaders :: DescribeUserStackAssociations -> [Header] #
ToPath DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods toPath :: DescribeUserStackAssociations -> ByteString #
ToQuery DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods toQuery :: DescribeUserStackAssociations -> QueryString #
type Rep DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations type Rep DescribeUserStackAssociations = D1 ('MetaData "DescribeUserStackAssociations" "Amazonka.AppStream.DescribeUserStackAssociations" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeUserStackAssociations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationType)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse DescribeUserStackAssociations Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations type AWSResponse DescribeUserStackAssociations = DescribeUserStackAssociationsResponse

newDescribeUserStackAssociations :: DescribeUserStackAssociations Source #

Create a value of DescribeUserStackAssociations 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:DescribeUserStackAssociations', describeUserStackAssociations_userName - The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

$sel:nextToken:DescribeUserStackAssociations', describeUserStackAssociations_nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

$sel:authenticationType:DescribeUserStackAssociations', describeUserStackAssociations_authenticationType - The authentication type for the user who is associated with the stack. You must specify USERPOOL.

$sel:maxResults:DescribeUserStackAssociations', describeUserStackAssociations_maxResults - The maximum size of each page of results.

$sel:stackName:DescribeUserStackAssociations', describeUserStackAssociations_stackName - The name of the stack that is associated with the user.

Request Lenses

describeUserStackAssociations_userName :: Lens' DescribeUserStackAssociations (Maybe Text) Source #

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

describeUserStackAssociations_nextToken :: Lens' DescribeUserStackAssociations (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

describeUserStackAssociations_authenticationType :: Lens' DescribeUserStackAssociations (Maybe AuthenticationType) Source #

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

describeUserStackAssociations_maxResults :: Lens' DescribeUserStackAssociations (Maybe Natural) Source #

The maximum size of each page of results.

describeUserStackAssociations_stackName :: Lens' DescribeUserStackAssociations (Maybe Text) Source #

The name of the stack that is associated with the user.

Destructuring the Response

data DescribeUserStackAssociationsResponse Source #

See: newDescribeUserStackAssociationsResponse smart constructor.

Constructors

DescribeUserStackAssociationsResponse'
Fields userStackAssociations :: Maybe (NonEmpty UserStackAssociation) The UserStackAssociation objects. nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeUserStackAssociationsResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods (==) :: DescribeUserStackAssociationsResponse -> DescribeUserStackAssociationsResponse -> Bool # (/=) :: DescribeUserStackAssociationsResponse -> DescribeUserStackAssociationsResponse -> Bool #
Show DescribeUserStackAssociationsResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods showsPrec :: Int -> DescribeUserStackAssociationsResponse -> ShowS # show :: DescribeUserStackAssociationsResponse -> String # showList :: [DescribeUserStackAssociationsResponse] -> ShowS #
Generic DescribeUserStackAssociationsResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Associated Types type Rep DescribeUserStackAssociationsResponse :: Type -> Type # Methods from :: DescribeUserStackAssociationsResponse -> Rep DescribeUserStackAssociationsResponse x # to :: Rep DescribeUserStackAssociationsResponse x -> DescribeUserStackAssociationsResponse #
NFData DescribeUserStackAssociationsResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations Methods rnf :: DescribeUserStackAssociationsResponse -> () #
type Rep DescribeUserStackAssociationsResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUserStackAssociations type Rep DescribeUserStackAssociationsResponse = D1 ('MetaData "DescribeUserStackAssociationsResponse" "Amazonka.AppStream.DescribeUserStackAssociations" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeUserStackAssociationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userStackAssociations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty UserStackAssociation))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUserStackAssociationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserStackAssociationsResponse'`
-> DescribeUserStackAssociationsResponse

Create a value of DescribeUserStackAssociationsResponse 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:userStackAssociations:DescribeUserStackAssociationsResponse', describeUserStackAssociationsResponse_userStackAssociations - The UserStackAssociation objects.

$sel:nextToken:DescribeUserStackAssociations', describeUserStackAssociationsResponse_nextToken - The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

$sel:httpStatus:DescribeUserStackAssociationsResponse', describeUserStackAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

describeUserStackAssociationsResponse_userStackAssociations :: Lens' DescribeUserStackAssociationsResponse (Maybe (NonEmpty UserStackAssociation)) Source #

The UserStackAssociation objects.

describeUserStackAssociationsResponse_nextToken :: Lens' DescribeUserStackAssociationsResponse (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

describeUserStackAssociationsResponse_httpStatus :: Lens' DescribeUserStackAssociationsResponse Int Source #

The response's http status code.