libZSservicesZSamazonka-outpostsZSamazonka-outposts
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.Outposts.ListOutposts

Description

Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID (use1-az1).

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Synopsis

Creating a Request

data ListOutposts Source #

See: newListOutposts smart constructor.

Constructors

ListOutposts' 

Fields

  • availabilityZoneFilter :: Maybe (NonEmpty Text)

    A filter for the Availibility Zone (us-east-1a) of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • lifeCycleStatusFilter :: Maybe (NonEmpty Text)

    A filter for the lifecycle status of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • nextToken :: Maybe Text
     
  • availabilityZoneIdFilter :: Maybe (NonEmpty Text)

    A filter for the AZ IDs (use1-az1) of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • maxResults :: Maybe Natural
     

Instances

Instances details
Eq ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

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

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

Read ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

readsPrec :: Int -> ReadS ListOutposts #

readList :: ReadS [ListOutposts] #

readPrec :: ReadPrec ListOutposts #

readListPrec :: ReadPrec [ListOutposts] #

Show ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

showsPrec :: Int -> ListOutposts -> ShowS #

show :: ListOutposts -> String #

showList :: [ListOutposts] -> ShowS #

Generic ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Associated Types

type Rep ListOutposts :: Type -> Type #

Methods

from :: ListOutposts -> Rep ListOutposts x #

to :: Rep ListOutposts x -> ListOutposts #

NFData ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

rnf :: ListOutposts -> () #

Hashable ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

hashWithSalt :: Int -> ListOutposts -> Int #

hash :: ListOutposts -> Int #

AWSRequest ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Associated Types

type AWSResponse ListOutposts #

Methods

request :: ListOutposts -> Request ListOutposts #

response :: MonadResource m => Logger -> Service -> Proxy ListOutposts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOutposts))) #

ToHeaders ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

toHeaders :: ListOutposts -> [Header] #

ToPath ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

toPath :: ListOutposts -> ByteString #

ToQuery ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

toQuery :: ListOutposts -> QueryString #

type Rep ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

type Rep ListOutposts = D1 ('MetaData "ListOutposts" "Amazonka.Outposts.ListOutposts" "libZSservicesZSamazonka-outpostsZSamazonka-outposts" 'False) (C1 ('MetaCons "ListOutposts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "availabilityZoneFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "lifeCycleStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "availabilityZoneIdFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListOutposts Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

type AWSResponse ListOutposts = ListOutpostsResponse

newListOutposts :: ListOutposts Source #

Create a value of ListOutposts 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:availabilityZoneFilter:ListOutposts', listOutposts_availabilityZoneFilter - A filter for the Availibility Zone (us-east-1a) of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

$sel:lifeCycleStatusFilter:ListOutposts', listOutposts_lifeCycleStatusFilter - A filter for the lifecycle status of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

$sel:nextToken:ListOutposts', listOutposts_nextToken - Undocumented member.

$sel:availabilityZoneIdFilter:ListOutposts', listOutposts_availabilityZoneIdFilter - A filter for the AZ IDs (use1-az1) of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

$sel:maxResults:ListOutposts', listOutposts_maxResults - Undocumented member.

Request Lenses

listOutposts_availabilityZoneFilter :: Lens' ListOutposts (Maybe (NonEmpty Text)) Source #

A filter for the Availibility Zone (us-east-1a) of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listOutposts_lifeCycleStatusFilter :: Lens' ListOutposts (Maybe (NonEmpty Text)) Source #

A filter for the lifecycle status of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listOutposts_nextToken :: Lens' ListOutposts (Maybe Text) Source #

Undocumented member.

listOutposts_availabilityZoneIdFilter :: Lens' ListOutposts (Maybe (NonEmpty Text)) Source #

A filter for the AZ IDs (use1-az1) of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listOutposts_maxResults :: Lens' ListOutposts (Maybe Natural) Source #

Undocumented member.

Destructuring the Response

data ListOutpostsResponse Source #

See: newListOutpostsResponse smart constructor.

Constructors

ListOutpostsResponse' 

Fields

Instances

Instances details
Eq ListOutpostsResponse Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

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

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

Read ListOutpostsResponse Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

readsPrec :: Int -> ReadS ListOutpostsResponse #

readList :: ReadS [ListOutpostsResponse] #

readPrec :: ReadPrec ListOutpostsResponse #

readListPrec :: ReadPrec [ListOutpostsResponse] #

Show ListOutpostsResponse Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

showsPrec :: Int -> ListOutpostsResponse -> ShowS #

show :: ListOutpostsResponse -> String #

showList :: [ListOutpostsResponse] -> ShowS #

Generic ListOutpostsResponse Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Associated Types

type Rep ListOutpostsResponse :: Type -> Type #

Methods

from :: ListOutpostsResponse -> Rep ListOutpostsResponse x #

to :: Rep ListOutpostsResponse x -> ListOutpostsResponse #

NFData ListOutpostsResponse Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

Methods

rnf :: ListOutpostsResponse -> () #

type Rep ListOutpostsResponse Source # 
Instance details

Defined in Amazonka.Outposts.ListOutposts

type Rep ListOutpostsResponse = D1 ('MetaData "ListOutpostsResponse" "Amazonka.Outposts.ListOutposts" "libZSservicesZSamazonka-outpostsZSamazonka-outposts" 'False) (C1 ('MetaCons "ListOutpostsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "outposts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Outpost])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListOutpostsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListOutpostsResponse'

-> ListOutpostsResponse 

Create a value of ListOutpostsResponse 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:ListOutposts', listOutpostsResponse_nextToken - Undocumented member.

$sel:outposts:ListOutpostsResponse', listOutpostsResponse_outposts - Undocumented member.

$sel:httpStatus:ListOutpostsResponse', listOutpostsResponse_httpStatus - The response's http status code.

Response Lenses

listOutpostsResponse_nextToken :: Lens' ListOutpostsResponse (Maybe Text) Source #

Undocumented member.

listOutpostsResponse_outposts :: Lens' ListOutpostsResponse (Maybe [Outpost]) Source #

Undocumented member.

listOutpostsResponse_httpStatus :: Lens' ListOutpostsResponse Int Source #

The response's http status code.