describe_consumable_resource `async` ¶

describe_consumable_resource(
    *,
    config_overrides: Optional[AsyncBatchClientConfig] = None,
    consumable_resource: Optional[String] = None,
) -> DescribeConsumableResourceResponse

Returns a description of the specified consumable resource.

Parameters:

consumable_resource (Optional[String], default: None ) –

The name or ARN of the consumable resource whose description will be returned.

Raises:

ClientException –

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
ServerException –

These errors are usually caused by a server issue.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To get a description of a consumable resource Returns a description of the specified consumable resource.

>>> await client.describe_consumable_resource(consumable_resource='myConsumableResource')

Source code in docs_src/capo_batch/_services/async_batch.py

async def describe_consumable_resource(
    self,
    *,
    config_overrides: Optional[AsyncBatchClientConfig] = None,
    consumable_resource: Optional["capo_batch.types.string.String"] = None,
) -> "capo_batch.types.describe_consumable_resource_response.DescribeConsumableResourceResponse":
    """<p>Returns a description of the specified consumable resource.</p>

    Args:
        consumable_resource: <p>The name or ARN of the consumable resource whose description will be returned.</p>

    Raises:
        capo_batch.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.</p>
        capo_batch.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_batch.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get a description of a consumable resource
        Returns a description of the specified consumable resource.

        >>> await client.describe_consumable_resource(consumable_resource='myConsumableResource')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_batch.types.describe_consumable_resource_request.DescribeConsumableResourceRequest]",
    ) -> AsyncOperationResponse[
        "capo_batch.types.describe_consumable_resource_response.DescribeConsumableResourceResponse"
    ]:
        import capo_batch._operations.aws_batch_v20160810.describe_consumable_resource

        (
            output,
            http_response,
        ) = await capo_batch._operations.aws_batch_v20160810.describe_consumable_resource.async_describe_consumable_resource(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConsumableResource")
    )
    input_: capo_batch.types.describe_consumable_resource_request.DescribeConsumableResourceRequest = {}
    if consumable_resource is not None:
        input_["consumable_resource"] = consumable_resource

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

describe_consumable_resource async ¶

describe_consumable_resource `async` ¶