Skip to content

describe_shared_resources async 

describe_shared_resources(
    broker_id: __string,
    *,
    config_overrides: Optional[AsyncmqClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
) -> DescribeSharedResourcesResponse

Returns the resources shared to a broker.

Parameters:

  • broker_id (__string) –

    The unique ID that Amazon MQ generates for the broker.

  • max_results (Optional[MaxResults], default: None ) –

    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.

  • next_token (Optional[__string], default: None ) –

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

Raises:

Source code in docs_src/capo_mq/_services/async_mq.py 
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
async def describe_shared_resources(
    self,
    broker_id: "capo_mq.types.__string.__string",
    *,
    config_overrides: Optional[AsyncmqClientConfig] = None,
    max_results: Optional["capo_mq.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_mq.types.__string.__string"] = None,
) -> "capo_mq.types.describe_shared_resources_response.DescribeSharedResourcesResponse":
    """<p>Returns the resources shared to a broker.</p>

    Args:
        broker_id: <p>The unique ID that Amazon MQ generates for the broker.</p>
        max_results: <p>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.</p>
        next_token: <p>The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.</p>

    Raises:
        capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_mq.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_mq.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_mq.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_mq.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mq.types.describe_shared_resources_request.DescribeSharedResourcesRequest]",
    ) -> AsyncOperationResponse[
        "capo_mq.types.describe_shared_resources_response.DescribeSharedResourcesResponse"
    ]:
        import capo_mq._operations.mq.describe_shared_resources

        (
            output,
            http_response,
        ) = await capo_mq._operations.mq.describe_shared_resources.async_describe_shared_resources(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSharedResources")
    )
    input_: capo_mq.types.describe_shared_resources_request.DescribeSharedResourcesRequest = {
        "broker_id": broker_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output