DescribeAction
Describes an action.
Request Syntax
{ "ActionName": "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.
- ActionName
-
The name of the action to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})Required: Yes
Response Syntax
{ "ActionArn": "string", "ActionName": "string", "ActionType": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Properties": { "string" : "string" }, "Source": { "SourceId": "string", "SourceType": "string", "SourceUri": "string" }, "Status": "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.
- ActionArn
-
The Amazon Resource Name (ARN) of the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:action/.* - ActionName
-
The name of the action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}) - ActionType
-
The type of the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- CreatedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- CreationTime
-
When the action was created.
Type: Timestamp
- Description
-
The description of the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3072.
Pattern:
.* - LastModifiedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- LastModifiedTime
-
When the action was last modified.
Type: Timestamp
- LineageGroupArn
-
The Amazon Resource Name (ARN) of the lineage group.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.* - MetadataProperties
-
Metadata properties of the tracking entity, trial, or trial component.
Type: MetadataProperties object
- Properties
-
A list of the action's properties.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 30 items.
Key Length Constraints: Minimum length of 0. Maximum length of 2500.
Key Pattern:
.*Value Length Constraints: Minimum length of 0. Maximum length of 2500.
Value Pattern:
.* - Source
-
The source of the action.
Type: ActionSource object
- Status
-
The status of the action.
Type: String
Valid Values:
Unknown | InProgress | Completed | Failed | Stopping | Stopped
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: