SFN / Client / describe_activity
describe_activity#
- SFN.Client.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), 'encryptionConfiguration': { 'kmsKeyId': 'string', 'kmsDataKeyReusePeriodSeconds': 123, 'type': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KMS_KEY' } }
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.
encryptionConfiguration (dict) –
Settings for configured server-side encryption.
kmsKeyId (string) –
An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
kmsDataKeyReusePeriodSeconds (integer) –
Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call
GenerateDataKey
. Only applies to customer managed keys.type (string) –
Encryption type
Exceptions
SFN.Client.exceptions.ActivityDoesNotExist
SFN.Client.exceptions.InvalidArn