MQ / Paginator / DescribeSharedResources

DescribeSharedResources

class MQ.Paginator.DescribeSharedResources

paginator = client.get_paginator('describe_shared_resources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MQ.Client.describe_shared_resources().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• BrokerId (string) –

  [REQUIRED]

  The unique ID that Amazon MQ generates for the broker.

• 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

{
    'SharedResources': [
        {
            'DnsNames': [
                'string',
            ],
            'Error': {
                'Code': 'QUOTA_EXCEEDED'|'SHARE_NOT_FOUND'|'INVITE_FAILED'|'SETUP_INCOMPLETE'|'INTERNAL_ERROR'|'AZ_MISMATCH'|'RESOURCE_CONFIGURATION_NOT_FOUND',
                'Message': 'string'
            },
            'ResourceArn': 'string',
            'ResourceShareArns': [
                'string',
            ],
            'Status': 'AVAILABLE'|'SETUP_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'PENDING_CREATE'|'PENDING_DELETE'|'ERROR',
            'Type': 'RESOURCE_SHARE'|'RESOURCE'
        },
    ]
}

Response Structure

• (dict) –

  HTTP Status Code 200: OK.

  • SharedResources (list) –

    A list of resources shared to the broker.

    • (dict) –

      Represents a resource that is shared with the broker, including its type, ARN, and current status.

      • DnsNames (list) –

        The DNS names accessible by the broker.

        • (string) –

      • Error (dict) –

        Information on the error encountered by the resource.

        • Code (string) –

          The error code associated with the error.

        • Message (string) –

          The error message.

      • ResourceArn (string) –

        The ARN of the shared resource.

      • ResourceShareArns (list) –

        The resource share ARNs to which the resource belongs.

        • (string) –

      • Status (string) –

        The status of the shared resource.

      • Type (string) –

        The type of shared resource.