Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Connect.ListContactReferences

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This API is in preview release for Amazon Connect and is subject to change.

For the specified referenceTypes, returns a list of references associated with the contact.

This operation returns paginated results.

Synopsis

Creating a Request

data ListContactReferences Source #

See: newListContactReferences smart constructor.

Constructors

ListContactReferences'

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.
This is not expected to be set, because the value returned in the previous response is always null.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contactId :: Text
The identifier of the initial contact.
referenceTypes :: [ReferenceType]
The type of reference.

Instances

Instances details

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

newListContactReferences Source #

Arguments

:: Text	`ListContactReferences`
-> Text	`ListContactReferences`
-> ListContactReferences

Create a value of ListContactReferences 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:

ListContactReferences, listContactReferences_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.

This is not expected to be set, because the value returned in the previous response is always null.

ListContactReferences, listContactReferences_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListContactReferences, listContactReferences_contactId - The identifier of the initial contact.

$sel:referenceTypes:ListContactReferences', listContactReferences_referenceTypes - The type of reference.

Request Lenses

listContactReferences_nextToken :: Lens' ListContactReferences (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.

This is not expected to be set, because the value returned in the previous response is always null.

listContactReferences_instanceId :: Lens' ListContactReferences Text Source #

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

listContactReferences_contactId :: Lens' ListContactReferences Text Source #

The identifier of the initial contact.

listContactReferences_referenceTypes :: Lens' ListContactReferences [ReferenceType] Source #

The type of reference.

Destructuring the Response

data ListContactReferencesResponse Source #

See: newListContactReferencesResponse smart constructor.

Constructors

ListContactReferencesResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. This is always returned as null in the response. referenceSummaryList :: Maybe [ReferenceSummary] Information about the flows. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListContactReferencesResponse Source #

Arguments

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

Create a value of ListContactReferencesResponse 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:

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

This is always returned as null in the response.

$sel:referenceSummaryList:ListContactReferencesResponse', listContactReferencesResponse_referenceSummaryList - Information about the flows.

$sel:httpStatus:ListContactReferencesResponse', listContactReferencesResponse_httpStatus - The response's http status code.

Response Lenses

listContactReferencesResponse_nextToken :: Lens' ListContactReferencesResponse (Maybe Text) Source #

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

This is always returned as null in the response.

listContactReferencesResponse_referenceSummaryList :: Lens' ListContactReferencesResponse (Maybe [ReferenceSummary]) Source #

Information about the flows.

listContactReferencesResponse_httpStatus :: Lens' ListContactReferencesResponse Int Source #

The response's http status code.