Skip to content

Returns the resources shared to a broker

Description

Returns the resources shared to a broker.

Usage

mq_describe_shared_resources(BrokerId, MaxResults, NextToken)

Arguments

  • BrokerId

    [required] The unique ID that Amazon MQ generates for the broker.

  • MaxResults

    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

    The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Value

A list with the following syntax:

list(
  NextToken = "string",
  SharedResources = list(
    list(
      DnsNames = list(
        "string"
      ),
      Error = list(
        Code = "QUOTA_EXCEEDED"|"SHARE_NOT_FOUND"|"INVITE_FAILED"|"SETUP_INCOMPLETE"|"INTERNAL_ERROR"|"AZ_MISMATCH"|"RESOURCE_CONFIGURATION_NOT_FOUND",
        Message = "string"
      ),
      ResourceArn = "string",
      ResourceShareArns = list(
        "string"
      ),
      Status = "AVAILABLE"|"SETUP_IN_PROGRESS"|"DELETION_IN_PROGRESS"|"PENDING_CREATE"|"PENDING_DELETE"|"ERROR",
      Type = "RESOURCE_SHARE"|"RESOURCE"
    )
  )
)

Request syntax

svc$describe_shared_resources(
  BrokerId = "string",
  MaxResults = 123,
  NextToken = "string"
)