get_component

GreengrassV2.Client.get_component(**kwargs)

Gets the recipe for a version of a component.

See also: AWS API Documentation

Request Syntax

response = client.get_component(
    recipeOutputFormat='JSON'|'YAML',
    arn='string'
)
Parameters
  • recipeOutputFormat (string) -- The format of the recipe.
  • arn (string) --

    [REQUIRED]

    The ARN of the component version.

Return type

dict

Returns

Response Syntax

{
    'recipeOutputFormat': 'JSON'|'YAML',
    'recipe': b'bytes',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • recipeOutputFormat (string) --

      The format of the recipe.

    • recipe (bytes) --

      The recipe of the component version.

    • tags (dict) --

      A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide .

      • (string) --
        • (string) --

Exceptions

  • GreengrassV2.Client.exceptions.ValidationException
  • GreengrassV2.Client.exceptions.AccessDeniedException
  • GreengrassV2.Client.exceptions.ResourceNotFoundException
  • GreengrassV2.Client.exceptions.ThrottlingException
  • GreengrassV2.Client.exceptions.InternalServerException