CloudControlApi / Paginator / ListResources

ListResources#

class CloudControlApi.Paginator.ListResources#
paginator = client.get_paginator('list_resources')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TypeName='string',
    TypeVersionId='string',
    RoleArn='string',
    ResourceModel='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • TypeName (string) –

    [REQUIRED]

    The name of the resource type.

  • TypeVersionId (string) – For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • RoleArn (string) –

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

  • ResourceModel (string) – The resource model to use to select the resources to return.

  • 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

{
    'TypeName': 'string',
    'ResourceDescriptions': [
        {
            'Identifier': 'string',
            'Properties': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • TypeName (string) –

      The name of the resource type.

    • ResourceDescriptions (list) –

      Information about the specified resources, including primary identifier and resource model.

      • (dict) –

        Represents information about a provisioned resource.

        • Identifier (string) –

          The primary identifier for the resource.

          For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

        • Properties (string) –

          A list of the resource properties and their current values.