create_workflow

MigrationHubOrchestrator.Client.create_workflow(**kwargs)

Create a workflow to orchestrate your migrations.

See also: AWS API Documentation

Request Syntax

response = client.create_workflow(
    name='string',
    description='string',
    templateId='string',
    applicationConfigurationId='string',
    inputParameters={
        'string': {
            'integerValue': 123,
            'stringValue': 'string',
            'listOfStringsValue': [
                'string',
            ],
            'mapOfStringValue': {
                'string': 'string'
            }
        }
    },
    stepTargets=[
        'string',
    ],
    tags={
        'string': 'string'
    }
)

Parameters

• name (string) --

  [REQUIRED]

  The name of the migration workflow.

• description (string) -- The description of the migration workflow.
• templateId (string) --

  [REQUIRED]

  The ID of the template.

• applicationConfigurationId (string) --

  [REQUIRED]

  The configuration ID of the application configured in Application Discovery Service.

• inputParameters (dict) --

  [REQUIRED]

  The input parameters required to create a migration workflow.

  • (string) --
    • (dict) --

      A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: integerValue, stringValue, listOfStringsValue, mapOfStringValue.

      • integerValue (integer) --

        The value of the integer.

      • stringValue (string) --

        String value.

      • listOfStringsValue (list) --

        List of string values.

        • (string) --
      • mapOfStringValue (dict) --

        Map of string values.

        • (string) --
          • (string) --
• stepTargets (list) --

  The servers on which a step will be run.

  • (string) --
• tags (dict) --

  The tags to add on a migration workflow.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'templateId': 'string',
    'adsApplicationConfigurationId': 'string',
    'workflowInputs': {
        'string': {
            'integerValue': 123,
            'stringValue': 'string',
            'listOfStringsValue': [
                'string',
            ],
            'mapOfStringValue': {
                'string': 'string'
            }
        }
    },
    'stepTargets': [
        'string',
    ],
    'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED',
    'creationTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • id (string) --

    The ID of the migration workflow.

  • arn (string) --

    The Amazon Resource Name (ARN) of the migration workflow.

  • name (string) --

    The name of the migration workflow.

  • description (string) --

    The description of the migration workflow.

  • templateId (string) --

    The ID of the template.

  • adsApplicationConfigurationId (string) --

    The configuration ID of the application configured in Application Discovery Service.

  • workflowInputs (dict) --

    The inputs for creating a migration workflow.

    • (string) --

      • (dict) --

        A map of key value pairs that is generated when you create a migration workflow. The key value pairs will differ based on your selection of the template.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: integerValue, stringValue, listOfStringsValue, mapOfStringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • integerValue (integer) --

          The value of the integer.

        • stringValue (string) --

          String value.

        • listOfStringsValue (list) --

          List of string values.

          • (string) --

        • mapOfStringValue (dict) --

          Map of string values.

          • (string) --
            • (string) --

  • stepTargets (list) --

    The servers on which a step will be run.

    • (string) --

  • status (string) --

    The status of the migration workflow.

  • creationTime (datetime) --

    The time at which the migration workflow was created.

  • tags (dict) --

    The tags to add on a migration workflow.

    • (string) --
      • (string) --

Exceptions

• MigrationHubOrchestrator.Client.exceptions.ThrottlingException
• MigrationHubOrchestrator.Client.exceptions.AccessDeniedException
• MigrationHubOrchestrator.Client.exceptions.InternalServerException
• MigrationHubOrchestrator.Client.exceptions.ValidationException