Gets a list of parameters for a pipeline execution.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"PipelineExecutionArn": "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.
- MaxResults
-
The maximum number of parameters to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the result of the previous
ListPipelineParametersForExecutionrequest was truncated, the response includes aNextToken. To retrieve the next set of parameters, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- PipelineExecutionArn
-
The Amazon Resource Name (ARN) of the pipeline execution.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*$Required: Yes
Response Syntax
{
"NextToken": "string",
"PipelineParameters": [
{
"Name": "string",
"Value": "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.
- NextToken
-
If the result of the previous
ListPipelineParametersForExecutionrequest was truncated, the response includes aNextToken. To retrieve the next set of parameters, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.* - PipelineParameters
-
Contains a list of pipeline parameters. This list can be empty.
Type: Array of Parameter objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
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:
