amazonka-support-2.0: Amazon Support 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.Support.DescribeServices

Description

Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
Synopsis

Creating a Request

data DescribeServices Source #

See: newDescribeServices smart constructor.

Constructors

DescribeServices' 

Fields

  • language :: Maybe Text

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

  • serviceCodeList :: Maybe [Text]

    A JSON-formatted list of service codes available for Amazon Web Services services.

Instances

Instances details
ToJSON DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

ToHeaders DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

ToPath DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

ToQuery DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

AWSRequest DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Associated Types

type AWSResponse DescribeServices #

Generic DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Associated Types

type Rep DescribeServices :: Type -> Type #

Read DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Show DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

NFData DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Methods

rnf :: DescribeServices -> () #

Eq DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Hashable DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

type AWSResponse DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

type Rep DescribeServices Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

type Rep DescribeServices = D1 ('MetaData "DescribeServices" "Amazonka.Support.DescribeServices" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "DescribeServices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceCodeList") '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_language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

$sel:serviceCodeList:DescribeServices', describeServices_serviceCodeList - A JSON-formatted list of service codes available for Amazon Web Services services.

Request Lenses

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

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

describeServices_serviceCodeList :: Lens' DescribeServices (Maybe [Text]) Source #

A JSON-formatted list of service codes available for Amazon Web Services services.

Destructuring the Response

data DescribeServicesResponse Source #

The list of Amazon Web Services services returned by the DescribeServices operation.

See: newDescribeServicesResponse smart constructor.

Constructors

DescribeServicesResponse' 

Fields

Instances

Instances details
Generic DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Associated Types

type Rep DescribeServicesResponse :: Type -> Type #

Read DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Show DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

NFData DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

Eq DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

type Rep DescribeServicesResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeServices

type Rep DescribeServicesResponse = D1 ('MetaData "DescribeServicesResponse" "Amazonka.Support.DescribeServices" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "DescribeServicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "services") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SupportService])) :*: 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:

$sel:services:DescribeServicesResponse', describeServicesResponse_services - A JSON-formatted list of Amazon Web Services services.

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

Response Lenses

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

A JSON-formatted list of Amazon Web Services services.