amazonka-pricing-2.0: Amazon Price List Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pricing.DescribeServices

Description

Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeServices Source #

See: newDescribeServices smart constructor.

Constructors

DescribeServices' 

Fields

  • formatVersion :: Maybe Text

    The format version that you want the response to be in.

    Valid values are: aws_v1

  • maxResults :: Maybe Natural

    The maximum number of results that you want returned in the response.

  • nextToken :: Maybe Text

    The pagination token that indicates the next set of results that you want to retrieve.

  • serviceCode :: Maybe Text

    The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank.

Instances

Instances details
ToJSON DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

ToHeaders DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

ToPath DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

ToQuery DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

AWSPager DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

AWSRequest DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Associated Types

type AWSResponse DescribeServices #

Generic DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Associated Types

type Rep DescribeServices :: Type -> Type #

Read DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Show DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

NFData DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Methods

rnf :: DescribeServices -> () #

Eq DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Hashable DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

type AWSResponse DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

type Rep DescribeServices Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

type Rep DescribeServices = D1 ('MetaData "DescribeServices" "Amazonka.Pricing.DescribeServices" "amazonka-pricing-2.0-2qV8x2ufXzQ7VdGqV3aokJ" 'False) (C1 ('MetaCons "DescribeServices'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "formatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeServices :: DescribeServices Source #

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

DescribeServices, describeServices_formatVersion - The format version that you want the response to be in.

Valid values are: aws_v1

$sel:maxResults:DescribeServices', describeServices_maxResults - The maximum number of results that you want returned in the response.

DescribeServices, describeServices_nextToken - The pagination token that indicates the next set of results that you want to retrieve.

DescribeServices, describeServices_serviceCode - The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank.

Request Lenses

describeServices_formatVersion :: Lens' DescribeServices (Maybe Text) Source #

The format version that you want the response to be in.

Valid values are: aws_v1

describeServices_maxResults :: Lens' DescribeServices (Maybe Natural) Source #

The maximum number of results that you want returned in the response.

describeServices_nextToken :: Lens' DescribeServices (Maybe Text) Source #

The pagination token that indicates the next set of results that you want to retrieve.

describeServices_serviceCode :: Lens' DescribeServices (Maybe Text) Source #

The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank.

Destructuring the Response

data DescribeServicesResponse Source #

See: newDescribeServicesResponse smart constructor.

Constructors

DescribeServicesResponse' 

Fields

Instances

Instances details
Generic DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Associated Types

type Rep DescribeServicesResponse :: Type -> Type #

Read DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Show DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

NFData DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

Eq DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

type Rep DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Pricing.DescribeServices

type Rep DescribeServicesResponse = D1 ('MetaData "DescribeServicesResponse" "Amazonka.Pricing.DescribeServices" "amazonka-pricing-2.0-2qV8x2ufXzQ7VdGqV3aokJ" 'False) (C1 ('MetaCons "DescribeServicesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "formatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "services") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PricingService])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeServicesResponse Source #

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

DescribeServices, describeServicesResponse_formatVersion - The format version of the response. For example, aws_v1.

DescribeServices, describeServicesResponse_nextToken - The pagination token for the next set of retrievable results.

$sel:services:DescribeServicesResponse', describeServicesResponse_services - The service metadata for the service or services in the response.

$sel:httpStatus:DescribeServicesResponse', describeServicesResponse_httpStatus - The response's http status code.

Response Lenses

describeServicesResponse_formatVersion :: Lens' DescribeServicesResponse (Maybe Text) Source #

The format version of the response. For example, aws_v1.

describeServicesResponse_nextToken :: Lens' DescribeServicesResponse (Maybe Text) Source #

The pagination token for the next set of retrievable results.

describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [PricingService]) Source #

The service metadata for the service or services in the response.