Snowball / Client / list_long_term_pricing

list_long_term_pricing#

Snowball.Client.list_long_term_pricing(**kwargs)#

Lists all long-term pricing types.

Request Syntax

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

Parameters:

MaxResults (integer) – The maximum number of ListLongTermPricing objects to return.
NextToken (string) – Because HTTP requests are stateless, this is the starting point for your next list of ListLongTermPricing to return.

Return type:

dict

Returns:

Response Syntax

{
    'LongTermPricingEntries': [
        {
            'LongTermPricingId': 'string',
            'LongTermPricingEndDate': datetime(2015, 1, 1),
            'LongTermPricingStartDate': datetime(2015, 1, 1),
            'LongTermPricingType': 'OneYear'|'ThreeYear'|'OneMonth',
            'CurrentActiveJob': 'string',
            'ReplacementJob': 'string',
            'IsLongTermPricingAutoRenew': True|False,
            'LongTermPricingStatus': 'string',
            'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C'|'V3_5S',
            'JobIds': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- LongTermPricingEntries (list) –
  
  Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type.
  - (dict) –
    
    Each LongTermPricingListEntry object contains information about a long-term pricing type.
    - LongTermPricingId (string) –
      
      The ID of the long-term pricing type for the device.
    - LongTermPricingEndDate (datetime) –
      
      The end date the long-term pricing contract.
    - LongTermPricingStartDate (datetime) –
      
      The start date of the long-term pricing contract.
    - LongTermPricingType (string) –
      
      The type of long-term pricing that was selected for the device.
    - CurrentActiveJob (string) –
      
      The current active jobs on the device the long-term pricing type.
    - ReplacementJob (string) –
      
      A new device that replaces a device that is ordered with long-term pricing.
    - IsLongTermPricingAutoRenew (boolean) –
      
      If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.
    - LongTermPricingStatus (string) –
      
      The status of the long-term pricing type.
    - SnowballType (string) –
      
      The type of Snow Family devices associated with this long-term pricing job.
    - JobIds (list) –
      
      The IDs of the jobs that are associated with a long-term pricing type.
      - (string) –
- NextToken (string) –
  
  Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list.

Exceptions

Snowball.Client.exceptions.InvalidResourceException
Snowball.Client.exceptions.InvalidNextTokenException