DescribeActivity
Describes an activity.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Request Syntax
{
"activityArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- activityArn
-
The Amazon Resource Name (ARN) of the activity to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
{
"activityArn": "string",
"creationDate": number,
"encryptionConfiguration": {
"kmsDataKeyReusePeriodSeconds": number,
"kmsKeyId": "string",
"type": "string"
},
"name": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- activityArn
-
The Amazon Resource Name (ARN) that identifies the activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- creationDate
-
The date the activity is created.
Type: Timestamp
- encryptionConfiguration
-
Settings for configured server-side encryption.
Type: EncryptionConfiguration object
- name
-
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,U+FFFE-FFFF) -
surrogates (
U+D800-DFFF) -
invalid characters (
U+10FFFF)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- ActivityDoesNotExist
-
The specified activity does not exist.
HTTP Status Code: 400
- InvalidArn
-
The provided Amazon Resource Name (ARN) is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
