libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53AutoNaming.ListInstances

Description

Lists summary information about the instances that you registered by using a specified service.

This operation returns paginated results.

Synopsis

Creating a Request

data ListInstances Source #

See: newListInstances smart constructor.

Constructors

ListInstances' 

Fields

  • nextToken :: Maybe Text

    For the first ListInstances request, omit this value.

    If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

  • maxResults :: Maybe Natural

    The maximum number of instances that you want Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

  • serviceId :: Text

    The ID of the service that you want to list instances for.

Instances

Instances details
Eq ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

(==) :: ListInstances -> ListInstances -> Bool #

(/=) :: ListInstances -> ListInstances -> Bool #

Read ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

readsPrec :: Int -> ReadS ListInstances #

readList :: ReadS [ListInstances] #

readPrec :: ReadPrec ListInstances #

readListPrec :: ReadPrec [ListInstances] #

Show ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

showsPrec :: Int -> ListInstances -> ShowS #

show :: ListInstances -> String #

showList :: [ListInstances] -> ShowS #

Generic ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.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.Route53AutoNaming.ListInstances

Methods

rnf :: ListInstances -> () #

Hashable ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

hashWithSalt :: Int -> ListInstances -> Int #

hash :: ListInstances -> Int #

ToJSON ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

toJSON :: ListInstances -> Value #

toEncoding :: ListInstances -> Encoding #

toJSONList :: [ListInstances] -> Value #

toEncodingList :: [ListInstances] -> Encoding #

AWSPager ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

page :: ListInstances -> AWSResponse ListInstances -> Maybe ListInstances #

AWSRequest ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.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.Route53AutoNaming.ListInstances

Methods

toHeaders :: ListInstances -> [Header] #

ToPath ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

toPath :: ListInstances -> ByteString #

ToQuery ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

toQuery :: ListInstances -> QueryString #

type Rep ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

type Rep ListInstances = D1 ('MetaData "ListInstances" "Amazonka.Route53AutoNaming.ListInstances" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" '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)) :*: S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListInstances Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

type AWSResponse ListInstances = ListInstancesResponse

newListInstances Source #

Arguments

:: Text

$sel:serviceId:ListInstances'

-> ListInstances 

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 - For the first ListInstances request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

$sel:maxResults:ListInstances', listInstances_maxResults - The maximum number of instances that you want Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

$sel:serviceId:ListInstances', listInstances_serviceId - The ID of the service that you want to list instances for.

Request Lenses

listInstances_nextToken :: Lens' ListInstances (Maybe Text) Source #

For the first ListInstances request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

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

The maximum number of instances that you want Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

listInstances_serviceId :: Lens' ListInstances Text Source #

The ID of the service that you want to list instances for.

Destructuring the Response

data ListInstancesResponse Source #

See: newListInstancesResponse smart constructor.

Constructors

ListInstancesResponse' 

Fields

  • nextToken :: Maybe Text

    If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

  • instances :: Maybe [InstanceSummary]

    Summary information about the instances that are associated with the specified service.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

(==) :: ListInstancesResponse -> ListInstancesResponse -> Bool #

(/=) :: ListInstancesResponse -> ListInstancesResponse -> Bool #

Read ListInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

readsPrec :: Int -> ReadS ListInstancesResponse #

readList :: ReadS [ListInstancesResponse] #

readPrec :: ReadPrec ListInstancesResponse #

readListPrec :: ReadPrec [ListInstancesResponse] #

Show ListInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

Methods

showsPrec :: Int -> ListInstancesResponse -> ShowS #

show :: ListInstancesResponse -> String #

showList :: [ListInstancesResponse] -> ShowS #

Generic ListInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.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.Route53AutoNaming.ListInstances

Methods

rnf :: ListInstancesResponse -> () #

type Rep ListInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListInstances

type Rep ListInstancesResponse = D1 ('MetaData "ListInstancesResponse" "Amazonka.Route53AutoNaming.ListInstances" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "ListInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceSummary])) :*: 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:nextToken:ListInstances', listInstancesResponse_nextToken - If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

$sel:instances:ListInstancesResponse', listInstancesResponse_instances - Summary information about the instances that are associated with the specified service.

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

Response Lenses

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

If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

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

Summary information about the instances that are associated with the specified service.

listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #

The response's http status code.