get_workflow

get_workflow(**kwargs)

Get migration workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the migration workflow.

Return type

dict

Returns

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'templateId': 'string',
    'adsApplicationConfigurationId': 'string',
    'adsApplicationName': 'string',
    'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED',
    'statusMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastStartTime': datetime(2015, 1, 1),
    'lastStopTime': datetime(2015, 1, 1),
    'lastModifiedTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'tools': [
        {
            'name': 'string',
            'url': 'string'
        },
    ],
    'totalSteps': 123,
    'completedSteps': 123,
    'workflowInputs': {
        'string': {
            'integerValue': 123,
            'stringValue': 'string',
            'listOfStringsValue': [
                'string',
            ],
            'mapOfStringValue': {
                'string': 'string'
            }
        }
    },
    'tags': {
        'string': 'string'
    },
    'workflowBucket': '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.

  • adsApplicationName (string) --

    The name of the application configured in Application Discovery Service.

  • status (string) --

    The status of the migration workflow.

  • statusMessage (string) --

    The status message of the migration workflow.

  • creationTime (datetime) --

    The time at which the migration workflow was created.

  • lastStartTime (datetime) --

    The time at which the migration workflow was last started.

  • lastStopTime (datetime) --

    The time at which the migration workflow was last stopped.

  • lastModifiedTime (datetime) --

    The time at which the migration workflow was last modified.

  • endTime (datetime) --

    The time at which the migration workflow ended.

  • tools (list) --

    List of AWS services utilized in a migration workflow.

    • (dict) --

      List of AWS services utilized in a migration workflow.

      • name (string) --

        The name of an AWS service.

      • url (string) --

        The URL of an AWS service.

  • totalSteps (integer) --

    The total number of steps in the migration workflow.

  • completedSteps (integer) --

    Get a list of completed steps in the migration workflow.

  • workflowInputs (dict) --

    The inputs required for creating the 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) --
  • tags (dict) --

    The tags added to the migration workflow.

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

    The Amazon S3 bucket where the migration logs are stored.

Exceptions

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