imagebuilder / Client / get_component



Gets a component object.

See also: AWS API Documentation

Request Syntax

response = client.get_component(

componentBuildVersionArn (string) –


The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix /\d+$.

Return type:



Response Syntax

    'requestId': 'string',
    'component': {
        'arn': 'string',
        'name': 'string',
        'version': 'string',
        'description': 'string',
        'changeDescription': 'string',
        'type': 'BUILD'|'TEST',
        'platform': 'Windows'|'Linux',
        'supportedOsVersions': [
        'state': {
            'status': 'DEPRECATED',
            'reason': 'string'
        'parameters': [
                'name': 'string',
                'type': 'string',
                'defaultValue': [
                'description': 'string'
        'owner': 'string',
        'data': 'string',
        'kmsKeyId': 'string',
        'encrypted': True|False,
        'dateCreated': 'string',
        'tags': {
            'string': 'string'
        'publisher': 'string',
        'obfuscate': True|False

Response Structure

  • (dict) –

    • requestId (string) –

      The request ID that uniquely identifies this request.

    • component (dict) –

      The component object specified in the request.

      • arn (string) –

        The Amazon Resource Name (ARN) of the component.

      • name (string) –

        The name of the component.

      • version (string) –

        The version of the component.

      • description (string) –

        The description of the component.

      • changeDescription (string) –

        Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

      • type (string) –

        The component type specifies whether Image Builder uses the component to build the image or only to test it.

      • platform (string) –

        The operating system platform of the component.

      • supportedOsVersions (list) –

        The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

        • (string) –

      • state (dict) –

        Describes the current status of the component. This is used for components that are no longer active.

        • status (string) –

          The current state of the component.

        • reason (string) –

          Describes how or why the component changed state.

      • parameters (list) –

        Contains parameter details for each of the parameters that the component document defined for the component.

        • (dict) –

          Defines a parameter that is used to provide configuration details for the component.

          • name (string) –

            The name of this input parameter.

          • type (string) –

            The type of input this parameter provides. The currently supported value is “string”.

          • defaultValue (list) –

            The default value of this parameter if no input is provided.

            • (string) –

          • description (string) –

            Describes this parameter.

      • owner (string) –

        The owner of the component.

      • data (string) –

        Component data contains the YAML document content for the component.

      • kmsKeyId (string) –

        The KMS key identifier used to encrypt the component.

      • encrypted (boolean) –

        The encryption status of the component.

      • dateCreated (string) –

        The date that Image Builder created the component.

      • tags (dict) –

        The tags that apply to the component.

        • (string) –

          • (string) –

      • publisher (string) –

        Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

      • obfuscate (boolean) –

        Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.


  • imagebuilder.Client.exceptions.ServiceException

  • imagebuilder.Client.exceptions.ClientException

  • imagebuilder.Client.exceptions.ServiceUnavailableException

  • imagebuilder.Client.exceptions.InvalidRequestException

  • imagebuilder.Client.exceptions.ForbiddenException

  • imagebuilder.Client.exceptions.CallRateLimitExceededException