MediaConnect / Client / list_offerings

list_offerings¶

MediaConnect.Client.list_offerings(**kwargs)¶

Displays a list of all offerings that are available to this account in the current Amazon Web Services Region. If you have an active reservation (which means you’ve purchased an offering that has already started and hasn’t expired yet), your account isn’t eligible for other offerings.

Request Syntax

response = client.list_offerings(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) –
The maximum number of results to return per API request.

For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
NextToken (string) –
The token that identifies the batch of results that you want to see.

For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Offerings': [
        {
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'OfferingArn': 'string',
            'OfferingDescription': 'string',
            'PricePerUnit': 'string',
            'PriceUnits': 'HOURLY',
            'ResourceSpecification': {
                'ReservedBitrate': 123,
                'ResourceType': 'Mbps_Outbound_Bandwidth'
            }
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  The token that identifies the batch of results that you want to see.
  
  For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
- Offerings (list) –
  
  A list of offerings that are available to this account in the current Amazon Web Services Region.
  - (dict) –
    
    A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
    - CurrencyCode (string) –
      
      The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
    - Duration (integer) –
      
      The length of time that your reservation would be active.
    - DurationUnits (string) –
      
      The unit of measurement for the duration of the offering.
    - OfferingArn (string) –
      
      The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
    - OfferingDescription (string) –
      
      A description of the offering.
    - PricePerUnit (string) –
      
      The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
    - PriceUnits (string) –
      
      The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
    - ResourceSpecification (dict) –
      
      A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
      - ReservedBitrate (integer) –
        
        The amount of outbound bandwidth that is discounted in the offering.
      - ResourceType (string) –
        
        The type of resource and the unit that is being billed for.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ServiceUnavailableException