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.DMS.DescribeFleetAdvisorDatabases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of Fleet Advisor databases in your account.

Synopsis

Creating a Request

data DescribeFleetAdvisorDatabases Source #

See: newDescribeFleetAdvisorDatabases smart constructor.

Constructors

DescribeFleetAdvisorDatabases'

Fields

filters :: Maybe [Filter]
If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:
- database-id – The ID of the database.
- database-name – The name of the database.
- database-engine – The name of the database engine.
- server-ip-address – The IP address of the database server.
- database-ip-address – The IP address of the database.
- collector-name – The name of the associated Fleet Advisor collector.
An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="45"
maxRecords :: Maybe Int
Sets the maximum number of records returned in the response.
nextToken :: Maybe Text
If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Instances

Instances details

ToJSON DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods toJSON :: DescribeFleetAdvisorDatabases -> Value # toEncoding :: DescribeFleetAdvisorDatabases -> Encoding # toJSONList :: [DescribeFleetAdvisorDatabases] -> Value # toEncodingList :: [DescribeFleetAdvisorDatabases] -> Encoding #
ToHeaders DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods toHeaders :: DescribeFleetAdvisorDatabases -> [Header] #
ToPath DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods toPath :: DescribeFleetAdvisorDatabases -> ByteString #
ToQuery DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods toQuery :: DescribeFleetAdvisorDatabases -> QueryString #
AWSRequest DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Associated Types type AWSResponse DescribeFleetAdvisorDatabases # Methods request :: (Service -> Service) -> DescribeFleetAdvisorDatabases -> Request DescribeFleetAdvisorDatabases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleetAdvisorDatabases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleetAdvisorDatabases))) #
Generic DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Associated Types type Rep DescribeFleetAdvisorDatabases :: Type -> Type # Methods from :: DescribeFleetAdvisorDatabases -> Rep DescribeFleetAdvisorDatabases x # to :: Rep DescribeFleetAdvisorDatabases x -> DescribeFleetAdvisorDatabases #
Read DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods readsPrec :: Int -> ReadS DescribeFleetAdvisorDatabases # readList :: ReadS [DescribeFleetAdvisorDatabases] # readPrec :: ReadPrec DescribeFleetAdvisorDatabases # readListPrec :: ReadPrec [DescribeFleetAdvisorDatabases] #
Show DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods showsPrec :: Int -> DescribeFleetAdvisorDatabases -> ShowS # show :: DescribeFleetAdvisorDatabases -> String # showList :: [DescribeFleetAdvisorDatabases] -> ShowS #
NFData DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods rnf :: DescribeFleetAdvisorDatabases -> () #
Eq DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods (==) :: DescribeFleetAdvisorDatabases -> DescribeFleetAdvisorDatabases -> Bool # (/=) :: DescribeFleetAdvisorDatabases -> DescribeFleetAdvisorDatabases -> Bool #
Hashable DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods hashWithSalt :: Int -> DescribeFleetAdvisorDatabases -> Int # hash :: DescribeFleetAdvisorDatabases -> Int #
type AWSResponse DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases type AWSResponse DescribeFleetAdvisorDatabases = DescribeFleetAdvisorDatabasesResponse
type Rep DescribeFleetAdvisorDatabases Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases type Rep DescribeFleetAdvisorDatabases = D1 ('MetaData "DescribeFleetAdvisorDatabases" "Amazonka.DMS.DescribeFleetAdvisorDatabases" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeFleetAdvisorDatabases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeFleetAdvisorDatabases :: DescribeFleetAdvisorDatabases Source #

Create a value of DescribeFleetAdvisorDatabases 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:filters:DescribeFleetAdvisorDatabases', describeFleetAdvisorDatabases_filters - If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:

database-id – The ID of the database.
database-name – The name of the database.
database-engine – The name of the database engine.
server-ip-address – The IP address of the database server.
database-ip-address – The IP address of the database.
collector-name – The name of the associated Fleet Advisor collector.

An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="45"

$sel:maxRecords:DescribeFleetAdvisorDatabases', describeFleetAdvisorDatabases_maxRecords - Sets the maximum number of records returned in the response.

DescribeFleetAdvisorDatabases, describeFleetAdvisorDatabases_nextToken - If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Request Lenses

describeFleetAdvisorDatabases_filters :: Lens' DescribeFleetAdvisorDatabases (Maybe [Filter]) Source #

If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:

database-id – The ID of the database.
database-name – The name of the database.
database-engine – The name of the database engine.
server-ip-address – The IP address of the database server.
database-ip-address – The IP address of the database.
collector-name – The name of the associated Fleet Advisor collector.

An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="45"

describeFleetAdvisorDatabases_maxRecords :: Lens' DescribeFleetAdvisorDatabases (Maybe Int) Source #

Sets the maximum number of records returned in the response.

describeFleetAdvisorDatabases_nextToken :: Lens' DescribeFleetAdvisorDatabases (Maybe Text) Source #

If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Destructuring the Response

data DescribeFleetAdvisorDatabasesResponse Source #

See: newDescribeFleetAdvisorDatabasesResponse smart constructor.

Constructors

DescribeFleetAdvisorDatabasesResponse'

Fields

databases :: Maybe [DatabaseResponse]
Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.
nextToken :: Maybe Text
If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeFleetAdvisorDatabasesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Associated Types type Rep DescribeFleetAdvisorDatabasesResponse :: Type -> Type # Methods from :: DescribeFleetAdvisorDatabasesResponse -> Rep DescribeFleetAdvisorDatabasesResponse x # to :: Rep DescribeFleetAdvisorDatabasesResponse x -> DescribeFleetAdvisorDatabasesResponse #
Read DescribeFleetAdvisorDatabasesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods readsPrec :: Int -> ReadS DescribeFleetAdvisorDatabasesResponse # readList :: ReadS [DescribeFleetAdvisorDatabasesResponse] # readPrec :: ReadPrec DescribeFleetAdvisorDatabasesResponse # readListPrec :: ReadPrec [DescribeFleetAdvisorDatabasesResponse] #
Show DescribeFleetAdvisorDatabasesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods showsPrec :: Int -> DescribeFleetAdvisorDatabasesResponse -> ShowS # show :: DescribeFleetAdvisorDatabasesResponse -> String # showList :: [DescribeFleetAdvisorDatabasesResponse] -> ShowS #
NFData DescribeFleetAdvisorDatabasesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods rnf :: DescribeFleetAdvisorDatabasesResponse -> () #
Eq DescribeFleetAdvisorDatabasesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases Methods (==) :: DescribeFleetAdvisorDatabasesResponse -> DescribeFleetAdvisorDatabasesResponse -> Bool # (/=) :: DescribeFleetAdvisorDatabasesResponse -> DescribeFleetAdvisorDatabasesResponse -> Bool #
type Rep DescribeFleetAdvisorDatabasesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorDatabases type Rep DescribeFleetAdvisorDatabasesResponse = D1 ('MetaData "DescribeFleetAdvisorDatabasesResponse" "Amazonka.DMS.DescribeFleetAdvisorDatabases" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeFleetAdvisorDatabasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "databases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatabaseResponse])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFleetAdvisorDatabasesResponse Source #

Arguments

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

Create a value of DescribeFleetAdvisorDatabasesResponse 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:databases:DescribeFleetAdvisorDatabasesResponse', describeFleetAdvisorDatabasesResponse_databases - Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.

DescribeFleetAdvisorDatabases, describeFleetAdvisorDatabasesResponse_nextToken - If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:httpStatus:DescribeFleetAdvisorDatabasesResponse', describeFleetAdvisorDatabasesResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetAdvisorDatabasesResponse_databases :: Lens' DescribeFleetAdvisorDatabasesResponse (Maybe [DatabaseResponse]) Source #

Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.

describeFleetAdvisorDatabasesResponse_nextToken :: Lens' DescribeFleetAdvisorDatabasesResponse (Maybe Text) Source #

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeFleetAdvisorDatabasesResponse_httpStatus :: Lens' DescribeFleetAdvisorDatabasesResponse Int Source #

The response's http status code.