NovaActService / Client / create_workflow_definition

create_workflow_definition

NovaActService.Client.create_workflow_definition(**kwargs)

Creates a new workflow definition template that can be used to execute multiple workflow runs.

See also: AWS API Documentation

Request Syntax

response = client.create_workflow_definition(
    name='string',
    description='string',
    exportConfig={
        's3BucketName': 'string',
        's3KeyPrefix': 'string'
    },
    clientToken='string'
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the workflow definition. Must be unique within your account and region.

  • description (string) – An optional description of the workflow definition’s purpose and functionality.

  • exportConfig (dict) –

    Configuration for exporting workflow execution data to Amazon Simple Storage Service.

    • s3BucketName (string) – [REQUIRED]

      The name of your Amazon S3 bucket, that Nova Act uses to export your workflow data. Note that the IAM role used to access Nova Act must also have write permissions to this bucket.

    • s3KeyPrefix (string) –

      An optional prefix for Amazon S3 object keys to organize exported data.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'ACTIVE'|'DELETING'
}

Response Structure

  • (dict) –

    • status (string) –

      The current status of the workflow definition after creation.

Exceptions

  • NovaActService.Client.exceptions.ServiceQuotaExceededException

  • NovaActService.Client.exceptions.AccessDeniedException

  • NovaActService.Client.exceptions.ConflictException

  • NovaActService.Client.exceptions.ThrottlingException

  • NovaActService.Client.exceptions.InternalServerException

  • NovaActService.Client.exceptions.ValidationException