imagebuilder / Client / create_workflow

create_workflow

imagebuilder.Client.create_workflow(**kwargs)

Creates a new workflow or a new version of an existing workflow. If a workflow with the same name and semantic version already exists, and your request changes its configuration, Image Builder creates a new build version. If the configuration is identical to the latest build version, the request fails because that workflow configuration already exists.

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',
    dryRun=True|False
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the workflow to create. Image Builder generates the workflow ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a workflow with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the workflow already exists.

  • 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. The upper limit is 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) – The UTF-8 encoded YAML document content for the workflow, up to 16,000 characters. For larger documents, store the document in Amazon S3 and specify the uri property instead. You must specify exactly one of the data or uri properties.

  • uri (string) –

    The uri of a YAML workflow document file stored in Amazon S3. This must be an S3 URL ( s3://bucket/key), and you must have permission to access the S3 bucket it points to. A workflow document that you provide from Amazon S3 can be up to your service quota for workflow size.

    Alternatively, you can specify the YAML document inline, using the workflow data property. You must specify exactly one of the data or uri properties.

  • kmsKeyId (string) – The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. 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. If you don’t specify a key, Image Builder encrypts the workflow document with a KMS key that Image Builder owns.

  • tags (dict) –

    Tags that apply to the workflow resource.

    • (string) –

      • (string) –

  • clientToken (string) –

    [REQUIRED]

    A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

    This field is autopopulated if not provided.

  • type (string) –

    [REQUIRED]

    The image creation stage that this workflow applies to. Image Builder validates the workflow document steps against the stage you specify.

  • dryRun (boolean) – Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

Return type:

dict

Returns:

Response Syntax

{
    'clientToken': 'string',
    'workflowBuildVersionArn': 'string',
    'latestVersionReferences': {
        'latestVersionArn': 'string',
        'latestMajorVersionArn': 'string',
        'latestMinorVersionArn': 'string',
        'latestPatchVersionArn': '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.

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

  • imagebuilder.Client.exceptions.DryRunOperationException