imagebuilder / Client / create_workflow

create_workflow

imagebuilder.Client.create_workflow(**kwargs)

Create a new workflow or a new version of an existing workflow.

See also: AWS API Documentation

Request Syntax

response = client.create_workflow(
    name='string',
    semanticVersion='string',
    description='string',
    changeDescription='string',
    data='string',
    uri='string',
    kmsKeyId='string',
    tags={
        'string': 'string'
    },
    clientToken='string',
    type='BUILD'|'TEST'|'DISTRIBUTION'
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the workflow to create.

• semanticVersion (string) –

  [REQUIRED]

  The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

  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 workflow.

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

• data (string) – Contains the UTF-8 encoded YAML document content for the workflow. 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 workflow resource.

• tags (dict) –

  Tags that apply to the workflow resource.

  • (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.

• type (string) –

  [REQUIRED]

  The phase in the image build process for which the workflow resource is responsible.

Return type:

dict

Returns:

Response Syntax

{
    'clientToken': 'string',
    'workflowBuildVersionArn': 'string'
}

Response Structure

• (dict) –

  • clientToken (string) –

    The client token that uniquely identifies the request.

  • workflowBuildVersionArn (string) –

    The Amazon Resource Name (ARN) of the workflow resource 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