imagebuilder / Client / import_component

import_component#

imagebuilder.Client.import_component(**kwargs)#

Imports a component and transforms its data into a component document.

See also: AWS API Documentation

Request Syntax

response = client.import_component(
    name='string',
    semanticVersion='string',
    description='string',
    changeDescription='string',
    type='BUILD'|'TEST',
    format='SHELL',
    platform='Windows'|'Linux'|'macOS',
    data='string',
    uri='string',
    kmsKeyId='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the component.

  • semanticVersion (string) –

    [REQUIRED]

    The semantic version of the component. This version follows the semantic version syntax.

    Note

    The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

  • description (string) – The description of the component. Describes the contents of the component.

  • changeDescription (string) – The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.

  • type (string) –

    [REQUIRED]

    The type of the component denotes whether the component is used to build the image, or only to test it.

  • format (string) –

    [REQUIRED]

    The format of the resource that you want to import as a component.

  • platform (string) –

    [REQUIRED]

    The platform of the component.

  • data (string) – The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

  • uri (string) – The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

  • kmsKeyId (string) – The ID of the KMS key that should be used to encrypt this component.

  • tags (dict) –

    The tags of the component.

    • (string) –

      • (string) –

  • clientToken (string) –

    [REQUIRED]

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'clientToken': 'string',
    'componentBuildVersionArn': 'string'
}

Response Structure

  • (dict) –

    • requestId (string) –

      The request ID that uniquely identifies this request.

    • clientToken (string) –

      The client token that uniquely identifies the request.

    • componentBuildVersionArn (string) –

      The Amazon Resource Name (ARN) of the imported component.

Exceptions

  • imagebuilder.Client.exceptions.ServiceException

  • imagebuilder.Client.exceptions.ClientException

  • imagebuilder.Client.exceptions.ServiceUnavailableException

  • imagebuilder.Client.exceptions.InvalidRequestException

  • imagebuilder.Client.exceptions.IdempotentParameterMismatchException

  • imagebuilder.Client.exceptions.ForbiddenException

  • imagebuilder.Client.exceptions.CallRateLimitExceededException

  • imagebuilder.Client.exceptions.InvalidVersionNumberException

  • imagebuilder.Client.exceptions.ResourceInUseException

  • imagebuilder.Client.exceptions.InvalidParameterCombinationException