describe_blue_green_deployments¶
Operation¶
describe_blue_green_deployments
¶
describe_blue_green_deployments(request: DescribeBlueGreenDeploymentsInput | DescribeBlueGreenDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeBlueGreenDeploymentsInputDict]) -> DescribeBlueGreenDeploymentsOutput
Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeBlueGreenDeploymentsInput | DescribeBlueGreenDeploymentsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeBlueGreenDeploymentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeBlueGreenDeploymentsOutput
|
An instance of |
describe_blue_green_deployments
async
¶
describe_blue_green_deployments(request: DescribeBlueGreenDeploymentsInput | DescribeBlueGreenDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeBlueGreenDeploymentsInputDict]) -> DescribeBlueGreenDeploymentsOutput
Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeBlueGreenDeploymentsInput | DescribeBlueGreenDeploymentsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeBlueGreenDeploymentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeBlueGreenDeploymentsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeBlueGreenDeploymentsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeBlueGreenDeploymentsInput.
Attributes¶
blue_green_deployment_identifier
instance-attribute
¶
blue_green_deployment_identifier: str | None
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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.
marker
instance-attribute
¶
marker: str | None
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.
max_records
instance-attribute
¶
max_records: int | None
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.
DescribeBlueGreenDeploymentsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeBlueGreenDeploymentsInput structure.
Attributes¶
blue_green_deployment_identifier
class-attribute
instance-attribute
¶
blue_green_deployment_identifier: str | None = ...
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.
filters
class-attribute
instance-attribute
¶
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.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
max_records
class-attribute
instance-attribute
¶
max_records: int | None = ...
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.
Output¶
DescribeBlueGreenDeploymentsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeBlueGreenDeploymentsOutput structure.
Attributes¶
blue_green_deployments
class-attribute
instance-attribute
¶
blue_green_deployments: list[BlueGreenDeployment] | None = ...
A list of blue/green deployments in the current account and Amazon Web Services Region.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
A pagination token that can be used in a later
DescribeBlueGreenDeployments request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.