RAM / Paginator / ListResources

ListResources

class RAM.Paginator.ListResources

paginator = client.get_paginator('list_resources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RAM.Client.list_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    principal='string',
    resourceType='string',
    resourceArns=[
        'string',
    ],
    resourceShareArns=[
        'string',
    ],
    resourceRegionScope='ALL'|'REGIONAL'|'GLOBAL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• resourceOwner (string) –

  [REQUIRED]

  Specifies that you want to list only the resource shares that match the following:

  • SELF – resources that your account shares with other accounts

  • OTHER-ACCOUNTS – resources that other accounts share with your account

• principal (string) – Specifies that you want to list only the resource shares that are associated with the specified principal.

• resourceType (string) –

  Specifies that you want to list only the resource shares that include resources of the specified resource type.

  For valid values, query the ListResourceTypes operation.

• resourceArns (list) –

  Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

  • (string) –

• resourceShareArns (list) –

  Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

  • (string) –

• resourceRegionScope (string) –

  Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.

  • GLOBAL – the results include only global resources or resource types.

  • REGIONAL – the results include only regional resources or resource types.

  The default value is ALL.

• 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

{
    'resources': [
        {
            'arn': 'string',
            'type': 'string',
            'resourceShareArn': 'string',
            'resourceGroupArn': 'string',
            'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
            'statusMessage': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'resourceRegionScope': 'REGIONAL'|'GLOBAL'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • resources (list) –

    An array of objects that contain information about the resources.

    • (dict) –

      Describes a resource associated with a resource share in RAM.

      • arn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • type (string) –

        The resource type. This takes the form of: service-code: resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.

      • resourceShareArn (string) –

        The Amazon Resource Name (ARN) of the resource share this resource is associated with.

      • resourceGroupArn (string) –

        The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

      • status (string) –

        The current status of the resource.

      • statusMessage (string) –

        A message about the status of the resource.

      • creationTime (datetime) –

        The date and time when the resource was associated with the resource share.

      • lastUpdatedTime (datetime) –

        The date an time when the association between the resource and the resource share was last updated.

      • resourceRegionScope (string) –

        Specifies the scope of visibility of this resource:

        • REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

        • GLOBAL – The resource can be accessed from any Amazon Web Services Region.

  • NextToken (string) –

    A token to resume pagination.