MQ / Client / describe_shared_resources

describe_shared_resources¶

MQ.Client.describe_shared_resources(**kwargs)¶

Returns the resources shared to a broker.

Request Syntax

response = client.describe_shared_resources(
    BrokerId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

BrokerId (string) –
[REQUIRED]

The unique ID that Amazon MQ generates for the broker.
MaxResults (integer) – The maximum number of resources that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
NextToken (string) – The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    '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.
- NextToken (string) –
  
  The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- 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.

Exceptions

MQ.Client.exceptions.NotFoundException
MQ.Client.exceptions.BadRequestException
MQ.Client.exceptions.InternalServerErrorException
MQ.Client.exceptions.ForbiddenException