Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeBlueGreenDeployments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about 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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeBlueGreenDeployments Source #

See: newDescribeBlueGreenDeployments smart constructor.

Constructors

DescribeBlueGreenDeployments'

Fields

blueGreenDeploymentIdentifier :: Maybe Text
The blue/green deployment identifier. If this parameter is specified, information from only the specific blue/green deployment is returned. This parameter isn't case-sensitive.
Constraints:
- If supplied, must match an existing blue/green deployment identifier.
filters :: Maybe [Filter]
A filter that specifies one or more blue/green deployments to describe.
Supported filters:
- 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 :: Maybe Text
An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Natural
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: Minimum 20, maximum 100.

Instances

Instances details

ToHeaders DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods toHeaders :: DescribeBlueGreenDeployments -> [Header] #
ToPath DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods toPath :: DescribeBlueGreenDeployments -> ByteString #
ToQuery DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods toQuery :: DescribeBlueGreenDeployments -> QueryString #
AWSPager DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods page :: DescribeBlueGreenDeployments -> AWSResponse DescribeBlueGreenDeployments -> Maybe DescribeBlueGreenDeployments #
AWSRequest DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Associated Types type AWSResponse DescribeBlueGreenDeployments # Methods request :: (Service -> Service) -> DescribeBlueGreenDeployments -> Request DescribeBlueGreenDeployments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBlueGreenDeployments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBlueGreenDeployments))) #
Generic DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Associated Types type Rep DescribeBlueGreenDeployments :: Type -> Type # Methods from :: DescribeBlueGreenDeployments -> Rep DescribeBlueGreenDeployments x # to :: Rep DescribeBlueGreenDeployments x -> DescribeBlueGreenDeployments #
Read DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods readsPrec :: Int -> ReadS DescribeBlueGreenDeployments # readList :: ReadS [DescribeBlueGreenDeployments] # readPrec :: ReadPrec DescribeBlueGreenDeployments # readListPrec :: ReadPrec [DescribeBlueGreenDeployments] #
Show DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods showsPrec :: Int -> DescribeBlueGreenDeployments -> ShowS # show :: DescribeBlueGreenDeployments -> String # showList :: [DescribeBlueGreenDeployments] -> ShowS #
NFData DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods rnf :: DescribeBlueGreenDeployments -> () #
Eq DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods (==) :: DescribeBlueGreenDeployments -> DescribeBlueGreenDeployments -> Bool # (/=) :: DescribeBlueGreenDeployments -> DescribeBlueGreenDeployments -> Bool #
Hashable DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods hashWithSalt :: Int -> DescribeBlueGreenDeployments -> Int # hash :: DescribeBlueGreenDeployments -> Int #
type AWSResponse DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments type AWSResponse DescribeBlueGreenDeployments = DescribeBlueGreenDeploymentsResponse
type Rep DescribeBlueGreenDeployments Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments type Rep DescribeBlueGreenDeployments = D1 ('MetaData "DescribeBlueGreenDeployments" "Amazonka.RDS.DescribeBlueGreenDeployments" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeBlueGreenDeployments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blueGreenDeploymentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newDescribeBlueGreenDeployments :: DescribeBlueGreenDeployments Source #

Create a value of DescribeBlueGreenDeployments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeBlueGreenDeployments, describeBlueGreenDeployments_blueGreenDeploymentIdentifier - The blue/green deployment identifier. If this parameter is specified, information from only the specific blue/green deployment is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing blue/green deployment identifier.

$sel:filters:DescribeBlueGreenDeployments', describeBlueGreenDeployments_filters - A filter that specifies one or more blue/green deployments to describe.

Supported filters:

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.

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

$sel:maxRecords:DescribeBlueGreenDeployments', describeBlueGreenDeployments_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: Minimum 20, maximum 100.

Request Lenses

describeBlueGreenDeployments_blueGreenDeploymentIdentifier :: Lens' DescribeBlueGreenDeployments (Maybe Text) Source #

The blue/green deployment identifier. If this parameter is specified, information from only the specific blue/green deployment is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing blue/green deployment identifier.

describeBlueGreenDeployments_filters :: Lens' DescribeBlueGreenDeployments (Maybe [Filter]) Source #

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

Supported filters:

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.

describeBlueGreenDeployments_marker :: Lens' DescribeBlueGreenDeployments (Maybe Text) Source #

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

describeBlueGreenDeployments_maxRecords :: Lens' DescribeBlueGreenDeployments (Maybe Natural) Source #

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: Minimum 20, maximum 100.

Destructuring the Response

data DescribeBlueGreenDeploymentsResponse Source #

See: newDescribeBlueGreenDeploymentsResponse smart constructor.

Constructors

DescribeBlueGreenDeploymentsResponse'
Fields blueGreenDeployments :: Maybe [BlueGreenDeployment] Contains a list of blue/green deployments for the user. marker :: Maybe Text A pagination token that can be used in a later DescribeBlueGreenDeployments request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeBlueGreenDeploymentsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Associated Types type Rep DescribeBlueGreenDeploymentsResponse :: Type -> Type # Methods from :: DescribeBlueGreenDeploymentsResponse -> Rep DescribeBlueGreenDeploymentsResponse x # to :: Rep DescribeBlueGreenDeploymentsResponse x -> DescribeBlueGreenDeploymentsResponse #
Read DescribeBlueGreenDeploymentsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods readsPrec :: Int -> ReadS DescribeBlueGreenDeploymentsResponse # readList :: ReadS [DescribeBlueGreenDeploymentsResponse] # readPrec :: ReadPrec DescribeBlueGreenDeploymentsResponse # readListPrec :: ReadPrec [DescribeBlueGreenDeploymentsResponse] #
Show DescribeBlueGreenDeploymentsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods showsPrec :: Int -> DescribeBlueGreenDeploymentsResponse -> ShowS # show :: DescribeBlueGreenDeploymentsResponse -> String # showList :: [DescribeBlueGreenDeploymentsResponse] -> ShowS #
NFData DescribeBlueGreenDeploymentsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods rnf :: DescribeBlueGreenDeploymentsResponse -> () #
Eq DescribeBlueGreenDeploymentsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments Methods (==) :: DescribeBlueGreenDeploymentsResponse -> DescribeBlueGreenDeploymentsResponse -> Bool # (/=) :: DescribeBlueGreenDeploymentsResponse -> DescribeBlueGreenDeploymentsResponse -> Bool #
type Rep DescribeBlueGreenDeploymentsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeBlueGreenDeployments type Rep DescribeBlueGreenDeploymentsResponse = D1 ('MetaData "DescribeBlueGreenDeploymentsResponse" "Amazonka.RDS.DescribeBlueGreenDeployments" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeBlueGreenDeploymentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blueGreenDeployments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BlueGreenDeployment])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBlueGreenDeploymentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeBlueGreenDeploymentsResponse'`
-> DescribeBlueGreenDeploymentsResponse

Create a value of DescribeBlueGreenDeploymentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blueGreenDeployments:DescribeBlueGreenDeploymentsResponse', describeBlueGreenDeploymentsResponse_blueGreenDeployments - Contains a list of blue/green deployments for the user.

DescribeBlueGreenDeployments, describeBlueGreenDeploymentsResponse_marker - A pagination token that can be used in a later DescribeBlueGreenDeployments request.

$sel:httpStatus:DescribeBlueGreenDeploymentsResponse', describeBlueGreenDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

describeBlueGreenDeploymentsResponse_blueGreenDeployments :: Lens' DescribeBlueGreenDeploymentsResponse (Maybe [BlueGreenDeployment]) Source #

Contains a list of blue/green deployments for the user.

describeBlueGreenDeploymentsResponse_marker :: Lens' DescribeBlueGreenDeploymentsResponse (Maybe Text) Source #

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

describeBlueGreenDeploymentsResponse_httpStatus :: Lens' DescribeBlueGreenDeploymentsResponse Int Source #

The response's http status code.