get_component `async` ¶

get_component(
    arn: ComponentVersionARN,
    *,
    config_overrides: Optional[AsyncGreengrassV2ClientConfig] = None,
    recipe_output_format: Optional[RecipeOutputFormat] = None,
) -> GetComponentResponse

Gets the recipe for a version of a component.

Parameters:

recipe_output_format (Optional[RecipeOutputFormat], default: None ) –

The format of the recipe.
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/async_greengrass_v2.py

async def get_component(
    self,
    arn: "capo_greengrassv2.types.component_version_arn.ComponentVersionARN",
    *,
    config_overrides: Optional[AsyncGreengrassV2ClientConfig] = None,
    recipe_output_format: Optional[
        "capo_greengrassv2.types.recipe_output_format.RecipeOutputFormat"
    ] = None,
) -> "capo_greengrassv2.types.get_component_response.GetComponentResponse":
    """<p>Gets the recipe for a version of a component.</p>

    Args:
        recipe_output_format: <p>The format of the recipe.</p>
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_greengrassv2.types.get_component_request.GetComponentRequest]",
    ) -> AsyncOperationResponse[
        "capo_greengrassv2.types.get_component_response.GetComponentResponse"
    ]:
        import capo_greengrassv2._operations.greengrass_v2.get_component

        (
            output,
            http_response,
        ) = await capo_greengrassv2._operations.greengrass_v2.get_component.async_get_component(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetComponent")
    )
    input_: capo_greengrassv2.types.get_component_request.GetComponentRequest = {
        "arn": arn
    }
    if recipe_output_format is not None:
        input_["recipe_output_format"] = recipe_output_format

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

get_component async ¶

get_component `async` ¶