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.ListApprovedOrigins

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.

Returns a paginated list of all approved origins associated with the instance.

This operation returns paginated results.

Creating a Request

data ListApprovedOrigins Source #

See: newListApprovedOrigins smart constructor.

Constructors

ListApprovedOrigins'
Fields maxResults :: Maybe Natural The maximum number of results to return per page. 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. instanceId :: Text The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newListApprovedOrigins Source #

Arguments

:: Text	`ListApprovedOrigins`
-> ListApprovedOrigins

Create a value of ListApprovedOrigins 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:maxResults:ListApprovedOrigins', listApprovedOrigins_maxResults - The maximum number of results to return per page.

ListApprovedOrigins, listApprovedOrigins_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.

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

Request Lenses

listApprovedOrigins_maxResults :: Lens' ListApprovedOrigins (Maybe Natural) Source #

The maximum number of results to return per page.

listApprovedOrigins_nextToken :: Lens' ListApprovedOrigins (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.

listApprovedOrigins_instanceId :: Lens' ListApprovedOrigins Text Source #

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

Destructuring the Response

data ListApprovedOriginsResponse Source #

See: newListApprovedOriginsResponse smart constructor.

Constructors

ListApprovedOriginsResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. origins :: Maybe [Text] The approved origins. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListApprovedOriginsResponse Source #

Arguments

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

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

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

$sel:origins:ListApprovedOriginsResponse', listApprovedOriginsResponse_origins - The approved origins.

$sel:httpStatus:ListApprovedOriginsResponse', listApprovedOriginsResponse_httpStatus - The response's http status code.

Response Lenses

listApprovedOriginsResponse_nextToken :: Lens' ListApprovedOriginsResponse (Maybe Text) Source #

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

listApprovedOriginsResponse_origins :: Lens' ListApprovedOriginsResponse (Maybe [Text]) Source #

The approved origins.

listApprovedOriginsResponse_httpStatus :: Lens' ListApprovedOriginsResponse Int Source #

The response's http status code.