Amazonka.S3Outposts.ListSharedEndpoints

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

Related actions include:

• CreateEndpoint
• DeleteEndpoint

This operation returns paginated results.

Creating a Request

data ListSharedEndpoints

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

ToHeaders ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

toHeaders :: ListSharedEndpoints -> [Header]

ToPath ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

toPath :: ListSharedEndpoints -> ByteString

ToQuery ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

toQuery :: ListSharedEndpoints -> QueryString

AWSPager ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

page :: ListSharedEndpoints -> AWSResponse ListSharedEndpoints -> Maybe ListSharedEndpoints

AWSRequest ListSharedEndpoints

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

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

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

readsPrec :: Int -> ReadS ListSharedEndpoints

readList :: ReadS [ListSharedEndpoints]

readPrec :: ReadPrec ListSharedEndpoints

readListPrec :: ReadPrec [ListSharedEndpoints]

Show ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

showsPrec :: Int -> ListSharedEndpoints -> ShowS

show :: ListSharedEndpoints -> String

showList :: [ListSharedEndpoints] -> ShowS

NFData ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

rnf :: ListSharedEndpoints -> ()

Eq ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

(==) :: ListSharedEndpoints -> ListSharedEndpoints -> Bool

(/=) :: ListSharedEndpoints -> ListSharedEndpoints -> Bool

Hashable ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

hashWithSalt :: Int -> ListSharedEndpoints -> Int

hash :: ListSharedEndpoints -> Int

type AWSResponse ListSharedEndpoints

Defined in Amazonka.S3Outposts.ListSharedEndpoints

type AWSResponse ListSharedEndpoints = ListSharedEndpointsResponse

type Rep ListSharedEndpoints

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

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)

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

listSharedEndpoints_nextToken :: Lens' ListSharedEndpoints (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.

listSharedEndpoints_outpostId :: Lens' ListSharedEndpoints Text

The ID of the Amazon Web Services Outpost.

Destructuring the Response

data ListSharedEndpointsResponse

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

Generic ListSharedEndpointsResponse

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

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

readsPrec :: Int -> ReadS ListSharedEndpointsResponse

readList :: ReadS [ListSharedEndpointsResponse]

readPrec :: ReadPrec ListSharedEndpointsResponse

readListPrec :: ReadPrec [ListSharedEndpointsResponse]

Show ListSharedEndpointsResponse

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

showsPrec :: Int -> ListSharedEndpointsResponse -> ShowS

show :: ListSharedEndpointsResponse -> String

showList :: [ListSharedEndpointsResponse] -> ShowS

NFData ListSharedEndpointsResponse

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

rnf :: ListSharedEndpointsResponse -> ()

Eq ListSharedEndpointsResponse

Defined in Amazonka.S3Outposts.ListSharedEndpoints

Methods

(==) :: ListSharedEndpointsResponse -> ListSharedEndpointsResponse -> Bool

(/=) :: ListSharedEndpointsResponse -> ListSharedEndpointsResponse -> Bool

type Rep ListSharedEndpointsResponse

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

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])

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)

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

The response's http status code.