:doc:`RDS <../../rds>` / Client / describe_blue_green_deployments

*******************************
describe_blue_green_deployments
*******************************



.. py:method:: RDS.Client.describe_blue_green_deployments(**kwargs)

  

  Describes one or more blue/green deployments.

   

  For more information, see `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html>`__ in the *Amazon RDS User Guide* and `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html>`__ in the *Amazon Aurora User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeBlueGreenDeployments>`_  


  **Request Syntax**
  ::

    response = client.describe_blue_green_deployments(
        BlueGreenDeploymentIdentifier='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        Marker='string',
        MaxRecords=123
    )
    
  :type BlueGreenDeploymentIdentifier: string
  :param BlueGreenDeploymentIdentifier: 

    The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.

     

    Constraints:

     

    
    * Must match an existing blue/green deployment identifier.
    

    

  
  :type Filters: list
  :param Filters: 

    A filter that specifies one or more blue/green deployments to describe.

     

    Valid Values:

     

    
    * ``blue-green-deployment-identifier`` - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.
     
    * ``blue-green-deployment-name`` - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.
     
    * ``source`` - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.
     
    * ``target`` - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.
    

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

       

      .. note::

        

        Currently, wildcards are not supported in filters.

        

       

      The following actions can be filtered:

       

      
      * ``DescribeDBClusterBacktracks``
       
      * ``DescribeDBClusterEndpoints``
       
      * ``DescribeDBClusters``
       
      * ``DescribeDBInstances``
       
      * ``DescribeDBRecommendations``
       
      * ``DescribeDBShardGroups``
       
      * ``DescribePendingMaintenanceActions``
      

      

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

        The name of the filter. Filter names are case-sensitive.

        

      
      - **Values** *(list) --* **[REQUIRED]** 

        One or more filter values. Filter values are case-sensitive.

        

      
        - *(string) --* 

        
    
    

  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeBlueGreenDeployments`` request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

     

    Default: 100

     

    Constraints:

     

    
    * Must be a minimum of 20.
     
    * Can't exceed 100.
    

    

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

    
    ::

      {
          'BlueGreenDeployments': [
              {
                  'BlueGreenDeploymentIdentifier': 'string',
                  'BlueGreenDeploymentName': 'string',
                  'Source': 'string',
                  'Target': 'string',
                  'SwitchoverDetails': [
                      {
                          'SourceMember': 'string',
                          'TargetMember': 'string',
                          'Status': 'string'
                      },
                  ],
                  'Tasks': [
                      {
                          'Name': 'string',
                          'Status': 'string'
                      },
                  ],
                  'Status': 'string',
                  'StatusDetails': 'string',
                  'CreateTime': datetime(2015, 1, 1),
                  'DeleteTime': datetime(2015, 1, 1),
                  'TagList': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **BlueGreenDeployments** *(list) --* 

        A list of blue/green deployments in the current account and Amazon Web Services Region.

        
        

        - *(dict) --* 

          Details about a blue/green deployment.

           

          For more information, see `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html>`__ in the *Amazon RDS User Guide* and `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html>`__ in the *Amazon Aurora User Guide*.

          
          

          - **BlueGreenDeploymentIdentifier** *(string) --* 

            The unique identifier of the blue/green deployment.

            
          

          - **BlueGreenDeploymentName** *(string) --* 

            The user-supplied name of the blue/green deployment.

            
          

          - **Source** *(string) --* 

            The source database for the blue/green deployment.

             

            Before switchover, the source database is the production database in the blue environment.

            
          

          - **Target** *(string) --* 

            The target database for the blue/green deployment.

             

            Before switchover, the target database is the clone database in the green environment.

            
          

          - **SwitchoverDetails** *(list) --* 

            The details about each source and target resource in the blue/green deployment.

            
            

            - *(dict) --* 

              Contains the details about a blue/green deployment.

               

              For more information, see `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html>`__ in the *Amazon RDS User Guide* and `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html>`__ in the *Amazon Aurora User Guide*.

              
              

              - **SourceMember** *(string) --* 

                The Amazon Resource Name (ARN) of a resource in the blue environment.

                
              

              - **TargetMember** *(string) --* 

                The Amazon Resource Name (ARN) of a resource in the green environment.

                
              

              - **Status** *(string) --* 

                The switchover status of a resource in a blue/green deployment.

                 

                Values:

                 

                
                * ``PROVISIONING`` - The resource is being prepared to switch over.
                 
                * ``AVAILABLE`` - The resource is ready to switch over.
                 
                * ``SWITCHOVER_IN_PROGRESS`` - The resource is being switched over.
                 
                * ``SWITCHOVER_COMPLETED`` - The resource has been switched over.
                 
                * ``SWITCHOVER_FAILED`` - The resource attempted to switch over but failed.
                 
                * ``MISSING_SOURCE`` - The source resource has been deleted.
                 
                * ``MISSING_TARGET`` - The target resource has been deleted.
                

                
          
        
          

          - **Tasks** *(list) --* 

            Either tasks to be performed or tasks that have been completed on the target database before switchover.

            
            

            - *(dict) --* 

              Details about a task for a blue/green deployment.

               

              For more information, see `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html>`__ in the *Amazon RDS User Guide* and `Using Amazon RDS Blue/Green Deployments for database updates <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html>`__ in the *Amazon Aurora User Guide*.

              
              

              - **Name** *(string) --* 

                The name of the blue/green deployment task.

                
              

              - **Status** *(string) --* 

                The status of the blue/green deployment task.

                 

                Valid Values:

                 

                
                * ``PENDING`` - The resource is being prepared for deployment.
                 
                * ``IN_PROGRESS`` - The resource is being deployed.
                 
                * ``COMPLETED`` - The resource has been deployed.
                 
                * ``FAILED`` - Deployment of the resource failed.
                

                
          
        
          

          - **Status** *(string) --* 

            The status of the blue/green deployment.

             

            Valid Values:

             

            
            * ``PROVISIONING`` - Resources are being created in the green environment.
             
            * ``AVAILABLE`` - Resources are available in the green environment.
             
            * ``SWITCHOVER_IN_PROGRESS`` - The deployment is being switched from the blue environment to the green environment.
             
            * ``SWITCHOVER_COMPLETED`` - Switchover from the blue environment to the green environment is complete.
             
            * ``INVALID_CONFIGURATION`` - Resources in the green environment are invalid, so switchover isn't possible.
             
            * ``SWITCHOVER_FAILED`` - Switchover was attempted but failed.
             
            * ``DELETING`` - The blue/green deployment is being deleted.
            

            
          

          - **StatusDetails** *(string) --* 

            Additional information about the status of the blue/green deployment.

            
          

          - **CreateTime** *(datetime) --* 

            The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

            
          

          - **DeleteTime** *(datetime) --* 

            The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

            
          

          - **TagList** *(list) --* 

            A list of tags.

             

            For more information, see `Tagging Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html>`__ in the *Amazon RDS User Guide* or `Tagging Amazon Aurora and Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html>`__ in the *Amazon Aurora User Guide*.

            
            

            - *(dict) --* 

              Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

               

              For more information, see `Tagging Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html>`__ in the *Amazon RDS User Guide* or `Tagging Amazon Aurora and Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html>`__ in the *Amazon Aurora User Guide*.

              
              

              - **Key** *(string) --* 

                A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

                
              

              - **Value** *(string) --* 

                A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

                
          
        
      
    
      

      - **Marker** *(string) --* 

        A pagination token that can be used in a later ``DescribeBlueGreenDeployments`` request.

        
  
  **Exceptions**
  
  *   :py:class:`RDS.Client.exceptions.BlueGreenDeploymentNotFoundFault`

  