describe_activity

describe_activity(**kwargs)

Describes an activity.

Note

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

See also: AWS API Documentation

Request Syntax

response = client.describe_activity(
    activityArn='string'
)
Parameters
activityArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the activity to describe.

Return type
dict
Returns
Response Syntax
{
    'activityArn': 'string',
    'name': 'string',
    'creationDate': datetime(2015, 1, 1)
}

Response Structure

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

      The Amazon Resource Name (ARN) that identifies the activity.

    • name (string) --

      The name of the activity.

      A name must not contain:

      • white space
      • brackets < > { } [ ]
      • wildcard characters ? *
      • special characters " # % \ ^ | ~ ` $ & , ; : /
      • control characters ( U+0000-001F , U+007F-009F )

      To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    • creationDate (datetime) --

      The date the activity is created.

Exceptions

  • SFN.Client.exceptions.ActivityDoesNotExist
  • SFN.Client.exceptions.InvalidArn