describe_blue_green_deployments ¶

def describe_blue_green_deployments(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    blue_green_deployment_identifier: Optional[
        "capo_rds.types.blue_green_deployment_identifier.BlueGreenDeploymentIdentifier"
    ] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
    max_records: Optional["capo_rds.types.max_records.MaxRecords"] = None,
) -> "capo_rds.types.describe_blue_green_deployments_response.DescribeBlueGreenDeploymentsResponse":
    """<p>Describes one or more blue/green deployments.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html"> Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora User Guide</i>.</p>

    Args:
        blue_green_deployment_identifier: <p>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.</p> <p>Constraints:</p> <ul> <li> <p>Must match an existing blue/green deployment identifier.</p> </li> </ul>
        filters: <p>A filter that specifies one or more blue/green deployments to describe.</p> <p>Valid Values:</p> <ul> <li> <p> <code>blue-green-deployment-identifier</code> - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.</p> </li> <li> <p> <code>blue-green-deployment-name</code> - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.</p> </li> <li> <p> <code>source</code> - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.</p> </li> <li> <p> <code>target</code> - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.</p> </li> </ul>
        marker: <p>An optional pagination token provided by a previous <code>DescribeBlueGreenDeployments</code> request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints:</p> <ul> <li> <p>Must be a minimum of 20.</p> </li> <li> <p>Can't exceed 100.</p> </li> </ul>

    Raises:
        capo_rds.errors.blue_green_deployment_not_found_fault.BlueGreenDeploymentNotFoundFault: <p> <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe a blue/green deployment of an RDS DB instance after creation completes
        The following example retrieves the details of a blue/green deployment after creation completes.

        >>> client.describe_blue_green_deployments(blue_green_deployment_identifier='bgd-v53303651eexfake')
        To describe a blue/green deployment for an Aurora MySQL DB cluster
        The following example retrieves the details of a blue/green deployment.

        >>> client.describe_blue_green_deployments(blue_green_deployment_identifier='bgd-wi89nwzglccsfake')
        To describe a blue/green deployment for an Aurora MySQL cluster after switchover
        The following example retrieves the details about a blue/green deployment after the green environment is promoted to be the production environment.

        >>> client.describe_blue_green_deployments(blue_green_deployment_identifier='bgd-wi89nwzglccsfake')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_blue_green_deployments_request.DescribeBlueGreenDeploymentsRequest]",
    ) -> OperationResponse[
        "capo_rds.types.describe_blue_green_deployments_response.DescribeBlueGreenDeploymentsResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_blue_green_deployments

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_blue_green_deployments.describe_blue_green_deployments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBlueGreenDeployments")
    )
    input_: capo_rds.types.describe_blue_green_deployments_request.DescribeBlueGreenDeploymentsRequest = {}
    if blue_green_deployment_identifier is not None:
        input_["blue_green_deployment_identifier"] = (
            blue_green_deployment_identifier
        )
    if filters is not None:
        input_["filters"] = filters
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output