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.DescribeFleetAdvisorSchemas

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of schemas detected by Fleet Advisor Collectors in your account.

Synopsis

Creating a Request

data DescribeFleetAdvisorSchemas Source #

See: newDescribeFleetAdvisorSchemas smart constructor.

Constructors

DescribeFleetAdvisorSchemas'

Fields

filters :: Maybe [Filter]
If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:
- complexity – The schema's complexity, for example Simple.
- database-id – The ID of the schema's database.
- database-ip-address – The IP address of the schema's database.
- database-name – The name of the schema's database.
- database-engine – The name of the schema database's engine.
- original-schema-name – The name of the schema's database's main schema.
- schema-id – The ID of the schema, for example 15.
- schema-name – The name of the schema.
- server-ip-address – The IP address of the schema database's server.
An example is: describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"
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 DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods toJSON :: DescribeFleetAdvisorSchemas -> Value # toEncoding :: DescribeFleetAdvisorSchemas -> Encoding # toJSONList :: [DescribeFleetAdvisorSchemas] -> Value # toEncodingList :: [DescribeFleetAdvisorSchemas] -> Encoding #
ToHeaders DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods toHeaders :: DescribeFleetAdvisorSchemas -> [Header] #
ToPath DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods toPath :: DescribeFleetAdvisorSchemas -> ByteString #
ToQuery DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods toQuery :: DescribeFleetAdvisorSchemas -> QueryString #
AWSRequest DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Associated Types type AWSResponse DescribeFleetAdvisorSchemas # Methods request :: (Service -> Service) -> DescribeFleetAdvisorSchemas -> Request DescribeFleetAdvisorSchemas # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleetAdvisorSchemas -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleetAdvisorSchemas))) #
Generic DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Associated Types type Rep DescribeFleetAdvisorSchemas :: Type -> Type # Methods from :: DescribeFleetAdvisorSchemas -> Rep DescribeFleetAdvisorSchemas x # to :: Rep DescribeFleetAdvisorSchemas x -> DescribeFleetAdvisorSchemas #
Read DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods readsPrec :: Int -> ReadS DescribeFleetAdvisorSchemas # readList :: ReadS [DescribeFleetAdvisorSchemas] # readPrec :: ReadPrec DescribeFleetAdvisorSchemas # readListPrec :: ReadPrec [DescribeFleetAdvisorSchemas] #
Show DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods showsPrec :: Int -> DescribeFleetAdvisorSchemas -> ShowS # show :: DescribeFleetAdvisorSchemas -> String # showList :: [DescribeFleetAdvisorSchemas] -> ShowS #
NFData DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods rnf :: DescribeFleetAdvisorSchemas -> () #
Eq DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods (==) :: DescribeFleetAdvisorSchemas -> DescribeFleetAdvisorSchemas -> Bool # (/=) :: DescribeFleetAdvisorSchemas -> DescribeFleetAdvisorSchemas -> Bool #
Hashable DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods hashWithSalt :: Int -> DescribeFleetAdvisorSchemas -> Int # hash :: DescribeFleetAdvisorSchemas -> Int #
type AWSResponse DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas type AWSResponse DescribeFleetAdvisorSchemas = DescribeFleetAdvisorSchemasResponse
type Rep DescribeFleetAdvisorSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas type Rep DescribeFleetAdvisorSchemas = D1 ('MetaData "DescribeFleetAdvisorSchemas" "Amazonka.DMS.DescribeFleetAdvisorSchemas" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeFleetAdvisorSchemas'" '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)))))

newDescribeFleetAdvisorSchemas :: DescribeFleetAdvisorSchemas Source #

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

complexity – The schema's complexity, for example Simple.
database-id – The ID of the schema's database.
database-ip-address – The IP address of the schema's database.
database-name – The name of the schema's database.
database-engine – The name of the schema database's engine.
original-schema-name – The name of the schema's database's main schema.
schema-id – The ID of the schema, for example 15.
schema-name – The name of the schema.
server-ip-address – The IP address of the schema database's server.

An example is: describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"

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

DescribeFleetAdvisorSchemas, describeFleetAdvisorSchemas_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

describeFleetAdvisorSchemas_filters :: Lens' DescribeFleetAdvisorSchemas (Maybe [Filter]) Source #

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

complexity – The schema's complexity, for example Simple.
database-id – The ID of the schema's database.
database-ip-address – The IP address of the schema's database.
database-name – The name of the schema's database.
database-engine – The name of the schema database's engine.
original-schema-name – The name of the schema's database's main schema.
schema-id – The ID of the schema, for example 15.
schema-name – The name of the schema.
server-ip-address – The IP address of the schema database's server.

An example is: describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"

describeFleetAdvisorSchemas_maxRecords :: Lens' DescribeFleetAdvisorSchemas (Maybe Int) Source #

Sets the maximum number of records returned in the response.

describeFleetAdvisorSchemas_nextToken :: Lens' DescribeFleetAdvisorSchemas (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 DescribeFleetAdvisorSchemasResponse Source #

See: newDescribeFleetAdvisorSchemasResponse smart constructor.

Constructors

DescribeFleetAdvisorSchemasResponse'

Fields

fleetAdvisorSchemas :: Maybe [SchemaResponse]
A collection of SchemaResponse objects.
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 DescribeFleetAdvisorSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Associated Types type Rep DescribeFleetAdvisorSchemasResponse :: Type -> Type # Methods from :: DescribeFleetAdvisorSchemasResponse -> Rep DescribeFleetAdvisorSchemasResponse x # to :: Rep DescribeFleetAdvisorSchemasResponse x -> DescribeFleetAdvisorSchemasResponse #
Read DescribeFleetAdvisorSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods readsPrec :: Int -> ReadS DescribeFleetAdvisorSchemasResponse # readList :: ReadS [DescribeFleetAdvisorSchemasResponse] # readPrec :: ReadPrec DescribeFleetAdvisorSchemasResponse # readListPrec :: ReadPrec [DescribeFleetAdvisorSchemasResponse] #
Show DescribeFleetAdvisorSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods showsPrec :: Int -> DescribeFleetAdvisorSchemasResponse -> ShowS # show :: DescribeFleetAdvisorSchemasResponse -> String # showList :: [DescribeFleetAdvisorSchemasResponse] -> ShowS #
NFData DescribeFleetAdvisorSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods rnf :: DescribeFleetAdvisorSchemasResponse -> () #
Eq DescribeFleetAdvisorSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas Methods (==) :: DescribeFleetAdvisorSchemasResponse -> DescribeFleetAdvisorSchemasResponse -> Bool # (/=) :: DescribeFleetAdvisorSchemasResponse -> DescribeFleetAdvisorSchemasResponse -> Bool #
type Rep DescribeFleetAdvisorSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorSchemas type Rep DescribeFleetAdvisorSchemasResponse = D1 ('MetaData "DescribeFleetAdvisorSchemasResponse" "Amazonka.DMS.DescribeFleetAdvisorSchemas" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeFleetAdvisorSchemasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetAdvisorSchemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SchemaResponse])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFleetAdvisorSchemasResponse Source #

Arguments

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

Create a value of DescribeFleetAdvisorSchemasResponse 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:fleetAdvisorSchemas:DescribeFleetAdvisorSchemasResponse', describeFleetAdvisorSchemasResponse_fleetAdvisorSchemas - A collection of SchemaResponse objects.

DescribeFleetAdvisorSchemas, describeFleetAdvisorSchemasResponse_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:DescribeFleetAdvisorSchemasResponse', describeFleetAdvisorSchemasResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetAdvisorSchemasResponse_fleetAdvisorSchemas :: Lens' DescribeFleetAdvisorSchemasResponse (Maybe [SchemaResponse]) Source #

A collection of SchemaResponse objects.

describeFleetAdvisorSchemasResponse_nextToken :: Lens' DescribeFleetAdvisorSchemasResponse (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.

describeFleetAdvisorSchemasResponse_httpStatus :: Lens' DescribeFleetAdvisorSchemasResponse Int Source #

The response's http status code.