DescribeServices

$result = $client->describeServices([/* ... */]);
$promise = $client->describeServicesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeServices([
    'FormatVersion' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServiceCode' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FormatVersion' => '<string>',
    'NextToken' => '<string>',
    'Services' => [
        [
            'AttributeNames' => ['<string>', ...],
            'ServiceCode' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters had an invalid value.

InvalidNextTokenException:

The pagination token is invalid. Try again without a pagination token.

NotFoundException:

The requested resource can't be found.

InternalErrorException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

You've made too many requests exceeding service quotas.

ExpiredNextTokenException:

The pagination token expired. Try again without a pagination token.

Examples

Example 1: To retrieve a list of services and service codes

Retrieves the service for the given Service Code.

$result = $client->describeServices([
    'FormatVersion' => 'aws_v1',
    'MaxResults' => 1,
    'ServiceCode' => 'AmazonEC2',
]);

Result syntax:

[
    'FormatVersion' => 'aws_v1',
    'NextToken' => 'abcdefg123',
    'Services' => [
        [
            'AttributeNames' => [
                'volumeType',
                'maxIopsvolume',
                'instanceCapacity10xlarge',
                'locationType',
                'operation',
            ],
            'ServiceCode' => 'AmazonEC2',
        ],
    ],
]

GetAttributeValues

$result = $client->getAttributeValues([/* ... */]);
$promise = $client->getAttributeValuesAsync([/* ... */]);

Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Billing and Cost Management User Guide.

Parameter Syntax

$result = $client->getAttributeValues([
    'AttributeName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServiceCode' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AttributeValues' => [
        [
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more parameters had an invalid value.

InvalidNextTokenException:

The pagination token is invalid. Try again without a pagination token.

NotFoundException:

The requested resource can't be found.

InternalErrorException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

You've made too many requests exceeding service quotas.

ExpiredNextTokenException:

The pagination token expired. Try again without a pagination token.

Examples

Example 1: To retrieve a list of attribute values

This operation returns a list of values available for the given attribute.

$result = $client->getAttributeValues([
    'AttributeName' => 'volumeType',
    'MaxResults' => 2,
    'ServiceCode' => 'AmazonEC2',
]);

Result syntax:

[
    'AttributeValues' => [
        [
            'Value' => 'Throughput Optimized HDD',
        ],
        [
            'Value' => 'Provisioned IOPS',
        ],
    ],
    'NextToken' => 'GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw==',
]

GetPriceListFileUrl

$result = $client->getPriceListFileUrl([/* ... */]);
$promise = $client->getPriceListFileUrlAsync([/* ... */]);

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.

Parameter Syntax

$result = $client->getPriceListFileUrl([
    'FileFormat' => '<string>', // REQUIRED
    'PriceListArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Url' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more parameters had an invalid value.

NotFoundException:

The requested resource can't be found.

AccessDeniedException:

General authentication failure. The request wasn't signed correctly.

InternalErrorException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

You've made too many requests exceeding service quotas.

ResourceNotFoundException:

The requested resource can't be found.

GetProducts

$result = $client->getProducts([/* ... */]);
$promise = $client->getProductsAsync([/* ... */]);

Returns a list of all products that match the filter criteria.

Parameter Syntax

$result = $client->getProducts([
    'Filters' => [
        [
            'Field' => '<string>', // REQUIRED
            'Type' => 'TERM_MATCH', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'FormatVersion' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServiceCode' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FormatVersion' => '<string>',
    'NextToken' => '<string>',
    'PriceList' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

One or more parameters had an invalid value.

InvalidNextTokenException:

The pagination token is invalid. Try again without a pagination token.

NotFoundException:

The requested resource can't be found.

InternalErrorException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

You've made too many requests exceeding service quotas.

ExpiredNextTokenException:

The pagination token expired. Try again without a pagination token.

ListPriceLists

$result = $client->listPriceLists([/* ... */]);
$promise = $client->listPriceListsAsync([/* ... */]);

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.

Parameter Syntax

$result = $client->listPriceLists([
    'CurrencyCode' => '<string>', // REQUIRED
    'EffectiveDate' => <integer || string || DateTime>, // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegionCode' => '<string>',
    'ServiceCode' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PriceLists' => [
        [
            'CurrencyCode' => '<string>',
            'FileFormats' => ['<string>', ...],
            'PriceListArn' => '<string>',
            'RegionCode' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters had an invalid value.

InvalidNextTokenException:

The pagination token is invalid. Try again without a pagination token.

NotFoundException:

The requested resource can't be found.

AccessDeniedException:

General authentication failure. The request wasn't signed correctly.

InternalErrorException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

You've made too many requests exceeding service quotas.

ResourceNotFoundException:

The requested resource can't be found.

ExpiredNextTokenException:

The pagination token expired. Try again without a pagination token.