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.Connect.ListUseCases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the use cases for the integration association.

This operation returns paginated results.

Creating a Request

data ListUseCases Source #

Provides summary information about the use cases for the specified integration association.

See: newListUseCases smart constructor.

Constructors

ListUseCases'

Fields

nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
maxResults :: Maybe Natural
The maximum number of results to return per page.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integrationAssociationId :: Text
The identifier for the integration association.

Instances

Instances details

Eq ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods (==) :: ListUseCases -> ListUseCases -> Bool # (/=) :: ListUseCases -> ListUseCases -> Bool #
Read ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods readsPrec :: Int -> ReadS ListUseCases # readList :: ReadS [ListUseCases] # readPrec :: ReadPrec ListUseCases # readListPrec :: ReadPrec [ListUseCases] #
Show ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods showsPrec :: Int -> ListUseCases -> ShowS # show :: ListUseCases -> String # showList :: [ListUseCases] -> ShowS #
Generic ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Associated Types type Rep ListUseCases :: Type -> Type # Methods from :: ListUseCases -> Rep ListUseCases x # to :: Rep ListUseCases x -> ListUseCases #
NFData ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods rnf :: ListUseCases -> () #
Hashable ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods hashWithSalt :: Int -> ListUseCases -> Int # hash :: ListUseCases -> Int #
AWSPager ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods page :: ListUseCases -> AWSResponse ListUseCases -> Maybe ListUseCases #
AWSRequest ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Associated Types type AWSResponse ListUseCases # Methods request :: ListUseCases -> Request ListUseCases # response :: MonadResource m => Logger -> Service -> Proxy ListUseCases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUseCases))) #
ToHeaders ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods toHeaders :: ListUseCases -> [Header] #
ToPath ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods toPath :: ListUseCases -> ByteString #
ToQuery ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods toQuery :: ListUseCases -> QueryString #
type Rep ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases type Rep ListUseCases = D1 ('MetaData "ListUseCases" "Amazonka.Connect.ListUseCases" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListUseCases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "integrationAssociationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUseCases Source #
Instance details Defined in Amazonka.Connect.ListUseCases type AWSResponse ListUseCases = ListUseCasesResponse

newListUseCases Source #

Arguments

:: Text	`$sel:instanceId:ListUseCases'`
-> Text	`$sel:integrationAssociationId:ListUseCases'`
-> ListUseCases

Create a value of ListUseCases 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:ListUseCases', listUseCases_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:maxResults:ListUseCases', listUseCases_maxResults - The maximum number of results to return per page.

$sel:instanceId:ListUseCases', listUseCases_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

$sel:integrationAssociationId:ListUseCases', listUseCases_integrationAssociationId - The identifier for the integration association.

Request Lenses

listUseCases_nextToken :: Lens' ListUseCases (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listUseCases_maxResults :: Lens' ListUseCases (Maybe Natural) Source #

The maximum number of results to return per page.

listUseCases_instanceId :: Lens' ListUseCases Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listUseCases_integrationAssociationId :: Lens' ListUseCases Text Source #

The identifier for the integration association.

Destructuring the Response

data ListUseCasesResponse Source #

See: newListUseCasesResponse smart constructor.

Constructors

ListUseCasesResponse'
Fields useCaseSummaryList :: Maybe [UseCase] The use cases. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListUseCasesResponse Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods (==) :: ListUseCasesResponse -> ListUseCasesResponse -> Bool # (/=) :: ListUseCasesResponse -> ListUseCasesResponse -> Bool #
Read ListUseCasesResponse Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods readsPrec :: Int -> ReadS ListUseCasesResponse # readList :: ReadS [ListUseCasesResponse] # readPrec :: ReadPrec ListUseCasesResponse # readListPrec :: ReadPrec [ListUseCasesResponse] #
Show ListUseCasesResponse Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods showsPrec :: Int -> ListUseCasesResponse -> ShowS # show :: ListUseCasesResponse -> String # showList :: [ListUseCasesResponse] -> ShowS #
Generic ListUseCasesResponse Source #
Instance details Defined in Amazonka.Connect.ListUseCases Associated Types type Rep ListUseCasesResponse :: Type -> Type # Methods from :: ListUseCasesResponse -> Rep ListUseCasesResponse x # to :: Rep ListUseCasesResponse x -> ListUseCasesResponse #
NFData ListUseCasesResponse Source #
Instance details Defined in Amazonka.Connect.ListUseCases Methods rnf :: ListUseCasesResponse -> () #
type Rep ListUseCasesResponse Source #
Instance details Defined in Amazonka.Connect.ListUseCases type Rep ListUseCasesResponse = D1 ('MetaData "ListUseCasesResponse" "Amazonka.Connect.ListUseCases" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListUseCasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "useCaseSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UseCase])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUseCasesResponse Source #

Arguments

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

Create a value of ListUseCasesResponse 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:useCaseSummaryList:ListUseCasesResponse', listUseCasesResponse_useCaseSummaryList - The use cases.

$sel:nextToken:ListUseCases', listUseCasesResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:httpStatus:ListUseCasesResponse', listUseCasesResponse_httpStatus - The response's http status code.

Response Lenses

listUseCasesResponse_useCaseSummaryList :: Lens' ListUseCasesResponse (Maybe [UseCase]) Source #

The use cases.

listUseCasesResponse_nextToken :: Lens' ListUseCasesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listUseCasesResponse_httpStatus :: Lens' ListUseCasesResponse Int Source #

The response's http status code.