GetFlowAlias
Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
Request Syntax
GET /flows/flowIdentifier/aliases/aliasIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- aliasIdentifier
-
The unique identifier of the alias for which to retrieve information.
Pattern:
^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(TSTALIASID|[0-9a-zA-Z]{10})$Required: Yes
- flowIdentifier
-
The unique identifier of the flow that the alias belongs to.
Pattern:
^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"description": "string",
"flowId": "string",
"id": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
],
"updatedAt": "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.
- arn
-
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern:
^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})$ - createdAt
-
The time at which the flow was created.
Type: Timestamp
- description
-
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
- flowId
-
The unique identifier of the flow that the alias belongs to.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$ - id
-
The unique identifier of the alias of the flow.
Type: String
Pattern:
^(TSTALIASID|[0-9a-zA-Z]{10})$ - name
-
The name of the flow alias.
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$ - routingConfiguration
-
Contains information about the version that the alias is mapped to.
Type: Array of FlowAliasRoutingConfigurationListItem objects
Array Members: Fixed number of 1 item.
- updatedAt
-
The time at which the flow alias was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
