imagebuilder / Client / create_component

create_component#

imagebuilder.Client.create_component(**kwargs)#

Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

  • Inline, using the data property in the request body.

  • A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

See also: AWS API Documentation

Request Syntax

response = client.create_component(
    name='string',
    semanticVersion='string',
    description='string',
    changeDescription='string',
    platform='Windows'|'Linux',
    supportedOsVersions=[
        'string',
    ],
    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.

    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

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

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

  • platform (string) –

    [REQUIRED]

    The operating system platform of the component.

  • supportedOsVersions (list) –

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

    • (string) –

  • data (string) – Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

  • uri (string) –

    The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

    Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

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

  • tags (dict) –

    The tags that apply to 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 component that the request created.

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

  • imagebuilder.Client.exceptions.ServiceQuotaExceededException