IoTSiteWise / Client / describe_task

describe_task

IoTSiteWise.Client.describe_task(**kwargs)

Retrieves detailed information about a specific task in a workspace.

See also: AWS API Documentation

Request Syntax

response = client.describe_task(
    workspaceName='string',
    taskName='string',
    taskVersion='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace.

  • taskName (string) –

    [REQUIRED]

    The name of the task.

  • taskVersion (string) – The version number of the task to retrieve. If not specified, returns the latest version.

Return type:

dict

Returns:

Response Syntax

{
    'workspaceName': 'string',
    'taskName': 'string',
    'description': 'string',
    'taskArn': 'string',
    'version': 'string',
    'taskConfiguration': {
        'containerTaskConfiguration': {
            'ecrUri': 'string',
            'taskExecutionRole': 'string',
            'processingType': 'GENERIC_COMPUTE_PROCESSING'|'HARDWARE_ACCELERATED_PROCESSING',
            'processingUnit': 'UNITS_2'|'UNITS_4'|'UNITS_8'|'UNITS_12'|'UNITS_16'|'UNITS_24'|'UNITS_32'|'UNITS_36'|'UNITS_48'|'UNITS_60'|'UNITS_64'|'UNITS_72'|'UNITS_84'|'UNITS_96',
            'command': [
                'string',
            ],
            'timeoutSeconds': 123,
            'environmentVariables': {
                'string': 'string'
            }
        }
    },
    'status': {
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        },
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    Response structure for DescribeTask operation.

    • workspaceName (string) –

      The name of the workspace.

    • taskName (string) –

      The name of the task.

    • description (string) –

      The description of the task.

    • taskArn (string) –

      The ARN of the task.

    • version (string) –

      The version of the task.

    • taskConfiguration (dict) –

      The task execution configuration. Contains a containerTaskConfiguration for custom container workloads.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: containerTaskConfiguration. 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'}

      • containerTaskConfiguration (dict) –

        Configuration for running a custom container image on managed compute.

        • ecrUri (string) –

          The Amazon ECR image URI for the task container.

        • taskExecutionRole (string) –

          The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.

        • processingType (string) –

          The processing type for compute resources.

        • processingUnit (string) –

          The processing unit allocation that determines the vCPU, memory, and GPU resources.

        • command (list) –

          The command to execute in the container.

          • (string) –

        • timeoutSeconds (integer) –

          The timeout in seconds for task execution. Default: 3600 (1 hour).

        • environmentVariables (dict) –

          Environment variables passed to the container at runtime.

          • (string) –

            Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

            • (string) –

              Environment variable value

    • status (dict) –

      The current lifecycle status of the task.

      • error (dict) –

        Contains associated error information, if any.

        • code (string) –

          The error code.

        • message (string) –

          The error message.

      • state (string) –

        The current status of the resource.

    • createdAt (datetime) –

      The time the task was created, in Unix epoch time.

    • updatedAt (datetime) –

      The time the task was last updated, in Unix epoch time.

Exceptions