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

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.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

This operation returns paginated results.

Creating a Request

data ListInstances Source #

See: newListInstances smart constructor.

Constructors

ListInstances'
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.

Instances

Instances details

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

newListInstances :: ListInstances Source #

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

Request Lenses

listInstances_nextToken :: Lens' ListInstances (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.

listInstances_maxResults :: Lens' ListInstances (Maybe Natural) Source #

The maximum number of results to return per page.

Destructuring the Response

data ListInstancesResponse Source #

See: newListInstancesResponse smart constructor.

Constructors

ListInstancesResponse'
Fields instanceSummaryList :: Maybe [InstanceSummary] Information about the instances. 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 ListInstancesResponse Source #
Instance details Defined in Amazonka.Connect.ListInstances Methods (==) :: ListInstancesResponse -> ListInstancesResponse -> Bool # (/=) :: ListInstancesResponse -> ListInstancesResponse -> Bool #
Show ListInstancesResponse Source #
Instance details Defined in Amazonka.Connect.ListInstances Methods showsPrec :: Int -> ListInstancesResponse -> ShowS # show :: ListInstancesResponse -> String # showList :: [ListInstancesResponse] -> ShowS #
Generic ListInstancesResponse Source #
Instance details Defined in Amazonka.Connect.ListInstances Associated Types type Rep ListInstancesResponse :: Type -> Type # Methods from :: ListInstancesResponse -> Rep ListInstancesResponse x # to :: Rep ListInstancesResponse x -> ListInstancesResponse #
NFData ListInstancesResponse Source #
Instance details Defined in Amazonka.Connect.ListInstances Methods rnf :: ListInstancesResponse -> () #
type Rep ListInstancesResponse Source #
Instance details Defined in Amazonka.Connect.ListInstances type Rep ListInstancesResponse = D1 ('MetaData "ListInstancesResponse" "Amazonka.Connect.ListInstances" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListInstancesResponse Source #

Arguments

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

Create a value of ListInstancesResponse 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:instanceSummaryList:ListInstancesResponse', listInstancesResponse_instanceSummaryList - Information about the instances.

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

$sel:httpStatus:ListInstancesResponse', listInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listInstancesResponse_instanceSummaryList :: Lens' ListInstancesResponse (Maybe [InstanceSummary]) Source #

Information about the instances.

listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text) Source #

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

listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #

The response's http status code.