Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

ListOutpostsWithS3

class S3Outposts.Paginator.ListOutpostsWithS3
paginator = client.get_paginator('list_outposts_with_s3')
paginate(**kwargs)

Creates an iterator that will paginate through responses from S3Outposts.Client.list_outposts_with_s3().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Outposts': [
        {
            'OutpostArn': 'string',
            'OutpostId': 'string',
            'OwnerId': 'string',
            'CapacityInBytes': 123
        },
    ],

}

Response Structure

  • (dict) --
    • Outposts (list) --

      Returns the list of Outposts that have the following characteristics:

      • outposts that have S3 provisioned
      • outposts that are Active (not pending any provisioning nor decommissioned)
      • outposts to which the the calling Amazon Web Services account has access
      • (dict) --

        Contains the details for the Outpost object.

        • OutpostArn (string) --

          Specifies the unique Amazon Resource Name (ARN) for the outpost.

        • OutpostId (string) --

          Specifies the unique identifier for the outpost.

        • OwnerId (string) --

          Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.

        • CapacityInBytes (integer) --

          The Amazon S3 capacity of the outpost in bytes.