:doc:`AgentsforBedrock <../../bedrock-agent>` / Client / update_flow_alias

*****************
update_flow_alias
*****************



.. py:method:: AgentsforBedrock.Client.update_flow_alias(**kwargs)

  

  Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see `Deploy a flow in Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html>`__ in the Amazon Bedrock User Guide.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateFlowAlias>`_  


  **Request Syntax**
  ::

    response = client.update_flow_alias(
        name='string',
        description='string',
        routingConfiguration=[
            {
                'flowVersion': 'string'
            },
        ],
        concurrencyConfiguration={
            'type': 'Automatic'|'Manual',
            'maxConcurrency': 123
        },
        flowIdentifier='string',
        aliasIdentifier='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the alias.

    

  
  :type description: string
  :param description: 

    A description for the alias.

    

  
  :type routingConfiguration: list
  :param routingConfiguration: **[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.

        

      
    

  :type concurrencyConfiguration: dict
  :param concurrencyConfiguration: 

    The configuration that specifies how nodes in the flow are executed in parallel.

    

  
    - **type** *(string) --* **[REQUIRED]** 

      The type of concurrency to use for parallel node execution. Specify one of the following options:

       

      
      * ``Automatic`` - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
       
      * ``Manual`` - You specify which nodes can be executed in parallel.
      

      

    
    - **maxConcurrency** *(integer) --* 

      The maximum number of nodes that can be executed concurrently in the flow.

      

    
  
  :type flowIdentifier: string
  :param flowIdentifier: **[REQUIRED]** 

    The unique identifier of the flow.

    

  
  :type aliasIdentifier: string
  :param aliasIdentifier: **[REQUIRED]** 

    The unique identifier of the alias.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'name': 'string',
          'description': 'string',
          'routingConfiguration': [
              {
                  'flowVersion': 'string'
              },
          ],
          'concurrencyConfiguration': {
              'type': 'Automatic'|'Manual',
              'maxConcurrency': 123
          },
          'flowId': 'string',
          'id': 'string',
          'arn': 'string',
          'createdAt': datetime(2015, 1, 1),
          'updatedAt': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **name** *(string) --* 

        The name of the alias.

        
      

      - **description** *(string) --* 

        The description of the flow.

        
      

      - **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.

            
      
    
      

      - **concurrencyConfiguration** *(dict) --* 

        The configuration that specifies how nodes in the flow are executed in parallel.

        
        

        - **type** *(string) --* 

          The type of concurrency to use for parallel node execution. Specify one of the following options:

           

          
          * ``Automatic`` - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
           
          * ``Manual`` - You specify which nodes can be executed in parallel.
          

          
        

        - **maxConcurrency** *(integer) --* 

          The maximum number of nodes that can be executed concurrently in the flow.

          
    
      

      - **flowId** *(string) --* 

        The unique identifier of the flow.

        
      

      - **id** *(string) --* 

        The unique identifier of the alias.

        
      

      - **arn** *(string) --* 

        The Amazon Resource Name (ARN) of the flow.

        
      

      - **createdAt** *(datetime) --* 

        The time at which the flow was created.

        
      

      - **updatedAt** *(datetime) --* 

        The time at which the alias was last updated.

        
  
  **Exceptions**
  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ThrottlingException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ValidationException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.InternalServerException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ConflictException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException`

  