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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the Fleet Advisor collectors in your account.

Synopsis

Creating a Request

data DescribeFleetAdvisorCollectors Source #

See: newDescribeFleetAdvisorCollectors smart constructor.

Constructors

DescribeFleetAdvisorCollectors'

Fields

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

newDescribeFleetAdvisorCollectors :: DescribeFleetAdvisorCollectors Source #

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

collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
collector-name – The name of the collector agent.

An example is: describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"

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

DescribeFleetAdvisorCollectors, describeFleetAdvisorCollectors_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

describeFleetAdvisorCollectors_filters :: Lens' DescribeFleetAdvisorCollectors (Maybe [Filter]) Source #

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

collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
collector-name – The name of the collector agent.

An example is: describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"

describeFleetAdvisorCollectors_maxRecords :: Lens' DescribeFleetAdvisorCollectors (Maybe Int) Source #

Sets the maximum number of records returned in the response.

describeFleetAdvisorCollectors_nextToken :: Lens' DescribeFleetAdvisorCollectors (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 DescribeFleetAdvisorCollectorsResponse Source #

See: newDescribeFleetAdvisorCollectorsResponse smart constructor.

Constructors

DescribeFleetAdvisorCollectorsResponse'

Fields

collectors :: Maybe [CollectorResponse]
Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.
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 DescribeFleetAdvisorCollectorsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorCollectors Associated Types type Rep DescribeFleetAdvisorCollectorsResponse :: Type -> Type # Methods from :: DescribeFleetAdvisorCollectorsResponse -> Rep DescribeFleetAdvisorCollectorsResponse x # to :: Rep DescribeFleetAdvisorCollectorsResponse x -> DescribeFleetAdvisorCollectorsResponse #
Read DescribeFleetAdvisorCollectorsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorCollectors Methods readsPrec :: Int -> ReadS DescribeFleetAdvisorCollectorsResponse # readList :: ReadS [DescribeFleetAdvisorCollectorsResponse] # readPrec :: ReadPrec DescribeFleetAdvisorCollectorsResponse # readListPrec :: ReadPrec [DescribeFleetAdvisorCollectorsResponse] #
Show DescribeFleetAdvisorCollectorsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorCollectors Methods showsPrec :: Int -> DescribeFleetAdvisorCollectorsResponse -> ShowS # show :: DescribeFleetAdvisorCollectorsResponse -> String # showList :: [DescribeFleetAdvisorCollectorsResponse] -> ShowS #
NFData DescribeFleetAdvisorCollectorsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorCollectors Methods rnf :: DescribeFleetAdvisorCollectorsResponse -> () #
Eq DescribeFleetAdvisorCollectorsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorCollectors Methods (==) :: DescribeFleetAdvisorCollectorsResponse -> DescribeFleetAdvisorCollectorsResponse -> Bool # (/=) :: DescribeFleetAdvisorCollectorsResponse -> DescribeFleetAdvisorCollectorsResponse -> Bool #
type Rep DescribeFleetAdvisorCollectorsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeFleetAdvisorCollectors type Rep DescribeFleetAdvisorCollectorsResponse = D1 ('MetaData "DescribeFleetAdvisorCollectorsResponse" "Amazonka.DMS.DescribeFleetAdvisorCollectors" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeFleetAdvisorCollectorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CollectorResponse])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFleetAdvisorCollectorsResponse Source #

Arguments

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

Create a value of DescribeFleetAdvisorCollectorsResponse 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:

DescribeFleetAdvisorCollectorsResponse, describeFleetAdvisorCollectorsResponse_collectors - Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.

DescribeFleetAdvisorCollectors, describeFleetAdvisorCollectorsResponse_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:DescribeFleetAdvisorCollectorsResponse', describeFleetAdvisorCollectorsResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetAdvisorCollectorsResponse_collectors :: Lens' DescribeFleetAdvisorCollectorsResponse (Maybe [CollectorResponse]) Source #

Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.

describeFleetAdvisorCollectorsResponse_nextToken :: Lens' DescribeFleetAdvisorCollectorsResponse (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.

describeFleetAdvisorCollectorsResponse_httpStatus :: Lens' DescribeFleetAdvisorCollectorsResponse Int Source #

The response's http status code.