S3Outposts / Client / list_shared_endpoints

list_shared_endpoints#

S3Outposts.Client.list_shared_endpoints(**kwargs)#

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

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.list_shared_endpoints(
    NextToken='string',
    MaxResults=123,
    OutpostId='string'
)
Parameters:

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

  • MaxResults (integer) – The maximum number of endpoints that will be returned in the response.

  • OutpostId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services Outpost.

Return type:

dict

Returns:

Response Syntax

{
    'Endpoints': [
        {
            'EndpointArn': 'string',
            'OutpostsId': 'string',
            'CidrBlock': 'string',
            'Status': 'Pending'|'Available'|'Deleting'|'Create_Failed'|'Delete_Failed',
            'CreationTime': datetime(2015, 1, 1),
            'NetworkInterfaces': [
                {
                    'NetworkInterfaceId': 'string'
                },
            ],
            'VpcId': 'string',
            'SubnetId': 'string',
            'SecurityGroupId': 'string',
            'AccessType': 'Private'|'CustomerOwnedIp',
            'CustomerOwnedIpv4Pool': 'string',
            'FailedReason': {
                'ErrorCode': 'string',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Endpoints (list) –

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

      • (dict) –

        Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only access points in the Amazon Simple Storage Service User Guide.

        • EndpointArn (string) –

          The Amazon Resource Name (ARN) of the endpoint.

        • OutpostsId (string) –

          The ID of the Outposts.

        • CidrBlock (string) –

          The VPC CIDR committed by this endpoint.

        • Status (string) –

          The status of the endpoint.

        • CreationTime (datetime) –

          The time the endpoint was created.

        • NetworkInterfaces (list) –

          The network interface of the endpoint.

          • (dict) –

            The container for the network interface.

            • NetworkInterfaceId (string) –

              The ID for the network interface.

        • VpcId (string) –

          The ID of the VPC used for the endpoint.

        • SubnetId (string) –

          The ID of the subnet used for the endpoint.

        • SecurityGroupId (string) –

          The ID of the security group used for the endpoint.

        • AccessType (string) –

          The type of connectivity used to access the Amazon S3 on Outposts endpoint.

        • CustomerOwnedIpv4Pool (string) –

          The ID of the customer-owned IPv4 address pool used for the endpoint.

        • FailedReason (dict) –

          The failure reason, if any, for a create or delete endpoint operation.

          • ErrorCode (string) –

            The failure code, if any, for a create or delete endpoint operation.

          • Message (string) –

            Additional error details describing the endpoint failure and recommended action.

    • NextToken (string) –

      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.

Exceptions