AgentsforBedrock / Client / create_flow_alias

create_flow_alias#

AgentsforBedrock.Client.create_flow_alias(**kwargs)#

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Request Syntax

response = client.create_flow_alias(
    clientToken='string',
    description='string',
    flowIdentifier='string',
    name='string',
    routingConfiguration=[
        {
            'flowVersion': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)

Parameters:

clientToken (string) –
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.
description (string) – A description for the alias.
flowIdentifier (string) –
[REQUIRED]

The unique identifier of the flow for which to create an alias.
name (string) –
[REQUIRED]

A name for the alias.
routingConfiguration (list) –
[REQUIRED]

Contains information about the version to which to map the alias.
- (dict) –
  
  Contains information about a version that the alias maps to.
  - flowVersion (string) –
    
    The version that the alias maps to.
tags (dict) –
Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'flowId': 'string',
    'id': 'string',
    'name': 'string',
    'routingConfiguration': [
        {
            'flowVersion': 'string'
        },
    ],
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the alias.
- createdAt (datetime) –
  
  The time at which the alias was created.
- description (string) –
  
  The description of the alias.
- flowId (string) –
  
  The unique identifier of the flow that the alias belongs to.
- id (string) –
  
  The unique identifier of the alias.
- name (string) –
  
  The name of the alias.
- routingConfiguration (list) –
  
  Contains information about the version that the alias is mapped to.
  - (dict) –
    
    Contains information about a version that the alias maps to.
    - flowVersion (string) –
      
      The version that the alias maps to.
- updatedAt (datetime) –
  
  The time at which the alias of the flow was last updated.

Exceptions

AgentsforBedrock.Client.exceptions.ThrottlingException
AgentsforBedrock.Client.exceptions.AccessDeniedException
AgentsforBedrock.Client.exceptions.ValidationException
AgentsforBedrock.Client.exceptions.InternalServerException
AgentsforBedrock.Client.exceptions.ResourceNotFoundException
AgentsforBedrock.Client.exceptions.ConflictException
AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException