imagebuilder / Client / get_component

get_component¶

imagebuilder.Client.get_component(**kwargs)¶

Retrieves a component object.

Request Syntax

response = client.get_component(
    componentBuildVersionArn='string'
)

Parameters:

componentBuildVersionArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the component that you want to get. You can specify a build version ARN, or a component version ARN. The version can use the x wildcard in trailing positions, for example 1.0.x or 1.x.x. Version ARNs resolve to the latest available matching component build version.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'component': {
        'arn': 'string',
        'name': 'string',
        'version': 'string',
        'description': 'string',
        'changeDescription': 'string',
        'type': 'BUILD'|'TEST',
        'platform': 'Windows'|'Linux'|'macOS',
        'supportedOsVersions': [
            'string',
        ],
        'state': {
            'status': 'DEPRECATED'|'DISABLED'|'ACTIVE',
            'reason': 'string'
        },
        'parameters': [
            {
                'name': 'string',
                'type': 'string',
                'defaultValue': [
                    'string',
                ],
                'description': 'string'
            },
        ],
        'owner': 'string',
        'data': 'string',
        'kmsKeyId': 'string',
        'encrypted': True|False,
        'dateCreated': 'string',
        'tags': {
            'string': 'string'
        },
        'publisher': 'string',
        'obfuscate': True|False,
        'productCodes': [
            {
                'productCodeId': 'string',
                'productCodeType': 'marketplace'
            },
        ]
    },
    'latestVersionReferences': {
        'latestVersionArn': 'string',
        'latestMajorVersionArn': 'string',
        'latestMinorVersionArn': 'string',
        'latestPatchVersionArn': 'string'
    }
}

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.
    - status (string) –
      
      The current state of the component. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.
    - 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. The value is your account ID for components that you own, the sharing account’s ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.
  - data (string) –
    
    Component data contains the YAML document content for the component.
  - kmsKeyId (string) –
    
    The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
  - encrypted (boolean) –
    
    Indicates whether the component data is encrypted at rest. Image Builder encrypts all component data at rest, so this value is always true. This field is retained for backward compatibility.
  - 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.
  - productCodes (list) –
    
    Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.
    - (dict) –
      
      Information about a single product code.
      - productCodeId (string) –
        
        For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto an EC2 AMI to ensure that components are billed correctly. If this property is empty, it might mean that the component is not published.
      - productCodeType (string) –
        
        The owner of the product code that’s billed. If this property is empty, it might mean that the component is not published.
- latestVersionReferences (dict) –
  
  A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
  - latestVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) of the Image Builder resource.
  - latestMajorVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
  - latestMinorVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
  - latestPatchVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Exceptions

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException