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.Outposts.ListOutposts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Synopsis

data ListOutposts = ListOutposts' {
- availabilityZoneFilter :: Maybe (NonEmpty Text)
- availabilityZoneIdFilter :: Maybe (NonEmpty Text)
- lifeCycleStatusFilter :: Maybe (NonEmpty Text)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListOutposts :: ListOutposts
listOutposts_availabilityZoneFilter :: Lens' ListOutposts (Maybe (NonEmpty Text))
listOutposts_availabilityZoneIdFilter :: Lens' ListOutposts (Maybe (NonEmpty Text))
listOutposts_lifeCycleStatusFilter :: Lens' ListOutposts (Maybe (NonEmpty Text))
listOutposts_maxResults :: Lens' ListOutposts (Maybe Natural)
listOutposts_nextToken :: Lens' ListOutposts (Maybe Text)
data ListOutpostsResponse = ListOutpostsResponse' {
- nextToken :: Maybe Text
- outposts :: Maybe [Outpost]
- httpStatus :: Int
}
newListOutpostsResponse :: Int -> ListOutpostsResponse
listOutpostsResponse_nextToken :: Lens' ListOutpostsResponse (Maybe Text)
listOutpostsResponse_outposts :: Lens' ListOutpostsResponse (Maybe [Outpost])
listOutpostsResponse_httpStatus :: Lens' ListOutpostsResponse Int

Creating a Request

data ListOutposts Source #

See: newListOutposts smart constructor.

Constructors

ListOutposts'
Fields availabilityZoneFilter :: Maybe (NonEmpty Text) Filters the results by Availability Zone (for example, `us-east-1a`). availabilityZoneIdFilter :: Maybe (NonEmpty Text) Filters the results by AZ ID (for example, `use1-az1`). lifeCycleStatusFilter :: Maybe (NonEmpty Text) Filters the results by the lifecycle status. maxResults :: Maybe Natural nextToken :: Maybe Text

Instances

Instances details

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 #
AWSRequest ListOutposts Source #
Instance details Defined in Amazonka.Outposts.ListOutposts Associated Types type AWSResponse ListOutposts # Methods request :: (Service -> Service) -> ListOutposts -> Request ListOutposts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListOutposts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOutposts))) #
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 #
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 #
NFData ListOutposts Source #
Instance details Defined in Amazonka.Outposts.ListOutposts Methods rnf :: ListOutposts -> () #
Eq ListOutposts Source #
Instance details Defined in Amazonka.Outposts.ListOutposts Methods (==) :: ListOutposts -> ListOutposts -> Bool # (/=) :: ListOutposts -> ListOutposts -> Bool #
Hashable ListOutposts Source #
Instance details Defined in Amazonka.Outposts.ListOutposts Methods hashWithSalt :: Int -> ListOutposts -> Int # hash :: ListOutposts -> Int #
type AWSResponse ListOutposts Source #
Instance details Defined in Amazonka.Outposts.ListOutposts type AWSResponse ListOutposts = ListOutpostsResponse
type Rep ListOutposts Source #
Instance details Defined in Amazonka.Outposts.ListOutposts type Rep ListOutposts = D1 ('MetaData "ListOutposts" "Amazonka.Outposts.ListOutposts" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" 'False) (C1 ('MetaCons "ListOutposts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "availabilityZoneFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "availabilityZoneIdFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "lifeCycleStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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 - Filters the results by Availability Zone (for example, us-east-1a).

$sel:availabilityZoneIdFilter:ListOutposts', listOutposts_availabilityZoneIdFilter - Filters the results by AZ ID (for example, use1-az1).

$sel:lifeCycleStatusFilter:ListOutposts', listOutposts_lifeCycleStatusFilter - Filters the results by the lifecycle status.

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

ListOutposts, listOutposts_nextToken - Undocumented member.

Request Lenses

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

Filters the results by Availability Zone (for example, us-east-1a).

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

Filters the results by AZ ID (for example, use1-az1).

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

Filters the results by the lifecycle status.

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

Undocumented member.

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

Undocumented member.

Destructuring the Response

data ListOutpostsResponse Source #

See: newListOutpostsResponse smart constructor.

Constructors

ListOutpostsResponse'
Fields nextToken :: Maybe Text outposts :: Maybe [Outpost] httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListOutpostsResponse Source #
Instance details Defined in Amazonka.Outposts.ListOutposts Methods rnf :: ListOutpostsResponse -> () #
Eq ListOutpostsResponse Source #
Instance details Defined in Amazonka.Outposts.ListOutposts Methods (==) :: ListOutpostsResponse -> ListOutpostsResponse -> Bool # (/=) :: ListOutpostsResponse -> ListOutpostsResponse -> Bool #
type Rep ListOutpostsResponse Source #
Instance details Defined in Amazonka.Outposts.ListOutposts type Rep ListOutpostsResponse = D1 ('MetaData "ListOutpostsResponse" "Amazonka.Outposts.ListOutposts" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" '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:

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.