describe_component ¶

describe_component(
    arn: ComponentVersionARN,
    *,
    config_overrides: Optional[GreengrassV2ClientConfig] = None,
) -> DescribeComponentResponse

Retrieves metadata for a version of a component.

Parameters:

arn (ComponentVersionARN) –

The ARN of the component version.

Raises:

AccessDeniedException –

You don't have permission to perform the action.
InternalServerException –

IoT Greengrass can't process your request right now. Try again later.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.
ValidationException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
UnknownServiceError –

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

Source code in docs_src/capo_greengrassv2/_services/greengrass_v2.py

def describe_component(
    self,
    arn: "capo_greengrassv2.types.component_version_arn.ComponentVersionARN",
    *,
    config_overrides: Optional[GreengrassV2ClientConfig] = None,
) -> (
    "capo_greengrassv2.types.describe_component_response.DescribeComponentResponse"
):
    """<p>Retrieves metadata for a version of a component.</p>

    Args:
        arn: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>

    Raises:
        capo_greengrassv2.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_greengrassv2.errors.internal_server_exception.InternalServerException: <p>IoT Greengrass can't process your request right now. Try again later.</p>
        capo_greengrassv2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_greengrassv2.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.</p>
        capo_greengrassv2.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_greengrassv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_greengrassv2.types.describe_component_request.DescribeComponentRequest]",
    ) -> OperationResponse[
        "capo_greengrassv2.types.describe_component_response.DescribeComponentResponse"
    ]:
        import capo_greengrassv2._operations.greengrass_v2.describe_component

        output, http_response = (
            capo_greengrassv2._operations.greengrass_v2.describe_component.describe_component(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeComponent")
    )
    input_: capo_greengrassv2.types.describe_component_request.DescribeComponentRequest = {
        "arn": arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output