CloudControlApi / Paginator / ListResourceRequests

ListResourceRequests

class CloudControlApi.Paginator.ListResourceRequests

paginator = client.get_paginator('list_resource_requests')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceRequestStatusFilter={
        'Operations': [
            'CREATE'|'DELETE'|'UPDATE',
        ],
        'OperationStatuses': [
            'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceRequestStatusFilter (dict) –

  The filter criteria to apply to the requests returned.

  • Operations (list) –

    The operation types to include in the filter.

    • (string) –

  • OperationStatuses (list) –

    The operation statuses to include in the filter.

    • PENDING: The operation has been requested, but not yet initiated.

    • IN_PROGRESS: The operation is in progress.

    • SUCCESS: The operation completed.

    • FAILED: The operation failed.

    • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

    • CANCEL_COMPLETE: The operation has been canceled.

    • (string) –

• 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

{
    'ResourceRequestStatusSummaries': [
        {
            'TypeName': 'string',
            'Identifier': 'string',
            'RequestToken': 'string',
            'Operation': 'CREATE'|'DELETE'|'UPDATE',
            'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
            'EventTime': datetime(2015, 1, 1),
            'ResourceModel': 'string',
            'StatusMessage': 'string',
            'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
            'RetryAfter': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • ResourceRequestStatusSummaries (list) –

    The requests that match the specified filter criteria.

    • (dict) –

      Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.

      • TypeName (string) –

        The name of the resource type used in the operation.

      • Identifier (string) –

        The primary identifier for the resource.

        Note

        In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

      • RequestToken (string) –

        The unique token representing this resource operation request.

        Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

      • Operation (string) –

        The resource operation type.

      • OperationStatus (string) –

        The current status of the resource operation request.

        • PENDING: The resource operation hasn’t yet started.

        • IN_PROGRESS: The resource operation is currently in progress.

        • SUCCESS: The resource operation has successfully completed.

        • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

        • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

        • CANCEL_COMPLETE: The resource operation has been canceled.

      • EventTime (datetime) –

        When the resource operation request was initiated.

      • ResourceModel (string) –

        A JSON string containing the resource model, consisting of each resource property and its current value.

      • StatusMessage (string) –

        Any message explaining the current status.

      • ErrorCode (string) –

        For requests with a status of FAILED, the associated error code.

        For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

      • RetryAfter (datetime) –

        When to next request the status of this resource operation request.