describe_component

describe_component(**kwargs)

Retrieves metadata for a version of a component.

See also: AWS API Documentation

Request Syntax

response = client.describe_component(
    arn='string'
)

Parameters

arn (string) --

[REQUIRED]

The ARN of the component version.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'componentName': 'string',
    'componentVersion': 'string',
    'creationTimestamp': datetime(2015, 1, 1),
    'publisher': 'string',
    'description': 'string',
    'status': {
        'componentState': 'REQUESTED'|'INITIATED'|'DEPLOYABLE'|'FAILED'|'DEPRECATED',
        'message': 'string',
        'errors': {
            'string': 'string'
        },
        'vendorGuidance': 'ACTIVE'|'DISCONTINUED'|'DELETED',
        'vendorGuidanceMessage': 'string'
    },
    'platforms': [
        {
            'name': 'string',
            'attributes': {
                'string': 'string'
            }
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • arn (string) --

    The ARN of the component version.

  • componentName (string) --

    The name of the component.

  • componentVersion (string) --

    The version of the component.

  • creationTimestamp (datetime) --

    The time at which the component was created, expressed in ISO 8601 format.

  • publisher (string) --

    The publisher of the component version.

  • description (string) --

    The description of the component version.

  • status (dict) --

    The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.

    • componentState (string) --

      The state of the component version.

    • message (string) --

      A message that communicates details, such as errors, about the status of the component version.

    • errors (dict) --

      A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

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

      The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

      • ACTIVE – This component version is available and recommended for use.
      • DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.
      • DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
    • vendorGuidanceMessage (string) --

      A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

  • platforms (list) --

    The platforms that the component version supports.

    • (dict) --

      Contains information about a platform that a component supports.

      • name (string) --

        The friendly name of the platform. This name helps you identify the platform.

        If you omit this parameter, IoT Greengrass creates a friendly name from the os and architecture of the platform.

      • attributes (dict) --

        A dictionary of attributes for the platform. The IoT Greengrass Core software defines the os and architecture by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide .

        • (string) --
          • (string) --
  • 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