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.S3Outposts.ListSharedEndpoints

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

Related actions include:

This operation returns paginated results.

Synopsis

data ListSharedEndpoints = ListSharedEndpoints' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- outpostId :: Text
}
newListSharedEndpoints :: Text -> ListSharedEndpoints
listSharedEndpoints_maxResults :: Lens' ListSharedEndpoints (Maybe Natural)
listSharedEndpoints_nextToken :: Lens' ListSharedEndpoints (Maybe Text)
listSharedEndpoints_outpostId :: Lens' ListSharedEndpoints Text
data ListSharedEndpointsResponse = ListSharedEndpointsResponse' {
- endpoints :: Maybe [Endpoint]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListSharedEndpointsResponse :: Int -> ListSharedEndpointsResponse
listSharedEndpointsResponse_endpoints :: Lens' ListSharedEndpointsResponse (Maybe [Endpoint])
listSharedEndpointsResponse_nextToken :: Lens' ListSharedEndpointsResponse (Maybe Text)
listSharedEndpointsResponse_httpStatus :: Lens' ListSharedEndpointsResponse Int

Creating a Request

data ListSharedEndpoints Source #

See: newListSharedEndpoints smart constructor.

Constructors

ListSharedEndpoints'
Fields maxResults :: Maybe Natural The maximum number of endpoints that will be returned in the response. nextToken :: Maybe Text If a previous response from this operation included a `NextToken` value, you can provide that value here to retrieve the next page of results. outpostId :: Text The ID of the Amazon Web Services Outpost.

Instances

Instances details

ToHeaders ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods toHeaders :: ListSharedEndpoints -> [Header] #
ToPath ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods toPath :: ListSharedEndpoints -> ByteString #
ToQuery ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods toQuery :: ListSharedEndpoints -> QueryString #
AWSPager ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods page :: ListSharedEndpoints -> AWSResponse ListSharedEndpoints -> Maybe ListSharedEndpoints #
AWSRequest ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Associated Types type AWSResponse ListSharedEndpoints # Methods request :: (Service -> Service) -> ListSharedEndpoints -> Request ListSharedEndpoints # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSharedEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSharedEndpoints))) #
Generic ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Associated Types type Rep ListSharedEndpoints :: Type -> Type # Methods from :: ListSharedEndpoints -> Rep ListSharedEndpoints x # to :: Rep ListSharedEndpoints x -> ListSharedEndpoints #
Read ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods readsPrec :: Int -> ReadS ListSharedEndpoints # readList :: ReadS [ListSharedEndpoints] # readPrec :: ReadPrec ListSharedEndpoints # readListPrec :: ReadPrec [ListSharedEndpoints] #
Show ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods showsPrec :: Int -> ListSharedEndpoints -> ShowS # show :: ListSharedEndpoints -> String # showList :: [ListSharedEndpoints] -> ShowS #
NFData ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods rnf :: ListSharedEndpoints -> () #
Eq ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods (==) :: ListSharedEndpoints -> ListSharedEndpoints -> Bool # (/=) :: ListSharedEndpoints -> ListSharedEndpoints -> Bool #
Hashable ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints Methods hashWithSalt :: Int -> ListSharedEndpoints -> Int # hash :: ListSharedEndpoints -> Int #
type AWSResponse ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints type AWSResponse ListSharedEndpoints = ListSharedEndpointsResponse
type Rep ListSharedEndpoints Source #
Instance details Defined in Amazonka.S3Outposts.ListSharedEndpoints type Rep ListSharedEndpoints = D1 ('MetaData "ListSharedEndpoints" "Amazonka.S3Outposts.ListSharedEndpoints" "amazonka-s3outposts-2.0-FXtMY52WtY5H7dQDI4FXOO" 'False) (C1 ('MetaCons "ListSharedEndpoints'" '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 "outpostId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSharedEndpoints Source #

Arguments

:: Text	`$sel:outpostId:ListSharedEndpoints'`
-> ListSharedEndpoints

Create a value of ListSharedEndpoints 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:ListSharedEndpoints', listSharedEndpoints_maxResults - The maximum number of endpoints that will be returned in the response.

ListSharedEndpoints, listSharedEndpoints_nextToken - If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.

$sel:outpostId:ListSharedEndpoints', listSharedEndpoints_outpostId - The ID of the Amazon Web Services Outpost.

Request Lenses

listSharedEndpoints_maxResults :: Lens' ListSharedEndpoints (Maybe Natural) Source #

The maximum number of endpoints that will be returned in the response.

listSharedEndpoints_nextToken :: Lens' ListSharedEndpoints (Maybe Text) Source #

If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.

listSharedEndpoints_outpostId :: Lens' ListSharedEndpoints Text Source #

The ID of the Amazon Web Services Outpost.

Destructuring the Response

data ListSharedEndpointsResponse Source #

See: newListSharedEndpointsResponse smart constructor.

Constructors

ListSharedEndpointsResponse'

Fields

endpoints :: Maybe [Endpoint]
The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).
nextToken :: Maybe Text
If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListSharedEndpointsResponse Source #

Arguments

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

Create a value of ListSharedEndpointsResponse 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:endpoints:ListSharedEndpointsResponse', listSharedEndpointsResponse_endpoints - The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).

ListSharedEndpoints, listSharedEndpointsResponse_nextToken - If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.

$sel:httpStatus:ListSharedEndpointsResponse', listSharedEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

listSharedEndpointsResponse_endpoints :: Lens' ListSharedEndpointsResponse (Maybe [Endpoint]) Source #

The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).

listSharedEndpointsResponse_nextToken :: Lens' ListSharedEndpointsResponse (Maybe Text) Source #

If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.

listSharedEndpointsResponse_httpStatus :: Lens' ListSharedEndpointsResponse Int Source #

The response's http status code.