# Offerings: list offerings ## URI `/prod/offerings` ## HTTP methods ### GET **Operation ID:** `ListOfferings` **Query parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resourceType | String | False | | | nextToken | String | False | | | channelConfiguration | String | False | | | duration | String | False | | | codec | String | False | | | videoQuality | String | False | | | resolution | String | False | | | maximumFramerate | String | False | | | channelClass | String | False | | | maxResults | String | False | | | maximumBitrate | String | False | | | specialFeature | String | False | | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | ListOfferingsResultModel | 200 response | | 400 | InvalidRequest | 400 response | | 403 | AccessDenied | 403 response | | 429 | LimitExceeded | 429 response | | 500 | InternalServiceError | 500 response | | 502 | BadGatewayException | 502 response | | 504 | GatewayTimeoutException | 504 response | ## Schemas ### Response bodies #### ListOfferingsResultModel schema ListOfferingsResultModel ``` { "nextToken": "string", "offerings": [ { "arn": "string", "currencyCode": "string", "duration": integer, "durationUnits": enum, "fixedPrice": number, "offeringDescription": "string", "offeringId": "string", "offeringType": enum, "region": "string", "resourceSpecification": { "channelClass": enum, "codec": enum, "maximumBitrate": enum, "maximumFramerate": enum, "resolution": enum, "resourceType": enum, "specialFeature": enum, "videoQuality": enum }, "usagePrice": number } ] } ``` #### InvalidRequest schema InvalidRequest ``` { "message": "string" } ``` #### AccessDenied schema AccessDenied ``` { "message": "string" } ``` #### LimitExceeded schema LimitExceeded ``` { "message": "string" } ``` #### InternalServiceError schema InternalServiceError ``` { "message": "string" } ``` #### BadGatewayException schema BadGatewayException ``` { "message": "string" } ``` #### GatewayTimeoutException schema GatewayTimeoutException ``` { "message": "string" } ``` ## Properties ### AccessDenied | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### BadGatewayException | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### ChannelClass A standard channel has two encoding pipelines and a single pipeline channel only has one. + `STANDARD` + `SINGLE_PIPELINE` ### GatewayTimeoutException | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### InternalServiceError | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### InvalidRequest | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### LimitExceeded | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### ListOfferingsResultModel ListOfferings response | Property | Type | Required | Description | | --- |--- |--- |--- | | nextToken | string | False | Token to retrieve the next page of results | | offerings | Array of type [Offering](#offerings-model-offering) | False | List of offerings | ### Offering Reserved resources available for purchase | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' | | currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' | | duration | integer | False | Lease duration, e.g. '12' | | durationUnits | [OfferingDurationUnits](#offerings-model-offeringdurationunits) | False | Units for duration, e.g. 'MONTHS' | | fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO\$1UPFRONT offering | | offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' | | offeringId | string | False | Unique offering ID, e.g. '87654321' | | offeringType | [OfferingType](#offerings-model-offeringtype) | False | Offering type, e.g. 'NO\$1UPFRONT' | | region | string | False | AWS Region, e.g. 'us-west-2' | | resourceSpecification | [ReservationResourceSpecification](#offerings-model-reservationresourcespecification) | False | Resource configuration details | | usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' | ### OfferingDurationUnits Units for duration, e.g. 'MONTHS' + `MONTHS` ### OfferingType Offering type, e.g. 'NO\$1UPFRONT' + `NO_UPFRONT` ### ReservationCodec Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO' + `MPEG2` + `AVC` + `HEVC` + `AUDIO` + `LINK` ### ReservationMaximumBitrate Maximum bitrate in megabits per second + `MAX_10_MBPS` + `MAX_20_MBPS` + `MAX_50_MBPS` ### ReservationMaximumFramerate Maximum framerate in frames per second (Outputs only) + `MAX_30_FPS` + `MAX_60_FPS` ### ReservationResolution Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines + `SD` + `HD` + `FHD` + `UHD` ### ReservationResourceSpecification Resource configuration (codec, resolution, bitrate, ...) | Property | Type | Required | Description | | --- |--- |--- |--- | | channelClass | [ChannelClass](#offerings-model-channelclass) | False | Channel class, e.g. 'STANDARD' | | codec | [ReservationCodec](#offerings-model-reservationcodec) | False | Codec, e.g. 'AVC' | | maximumBitrate | [ReservationMaximumBitrate](#offerings-model-reservationmaximumbitrate) | False | Maximum bitrate, e.g. 'MAX\$120\$1MBPS' | | maximumFramerate | [ReservationMaximumFramerate](#offerings-model-reservationmaximumframerate) | False | Maximum framerate, e.g. 'MAX\$130\$1FPS' (Outputs only) | | resolution | [ReservationResolution](#offerings-model-reservationresolution) | False | Resolution, e.g. 'HD' | | resourceType | [ReservationResourceType](#offerings-model-reservationresourcetype) | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | | specialFeature | [ReservationSpecialFeature](#offerings-model-reservationspecialfeature) | False | Special feature, e.g. 'AUDIO\$1NORMALIZATION' (Channels only) | | videoQuality | [ReservationVideoQuality](#offerings-model-reservationvideoquality) | False | Video quality, e.g. 'STANDARD' (Outputs only) | ### ReservationResourceType Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' + `INPUT` + `OUTPUT` + `MULTIPLEX` + `CHANNEL` ### ReservationSpecialFeature Special features, 'ADVANCED\$1AUDIO' 'AUDIO\$1NORMALIZATION' 'MGHD' or 'MGUHD' + `ADVANCED_AUDIO` + `AUDIO_NORMALIZATION` + `MGHD` + `MGUHD` ### ReservationVideoQuality Video quality, e.g. 'STANDARD' (Outputs only) + `STANDARD` + `ENHANCED` + `PREMIUM` ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### ListOfferings + [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/ListOfferings) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/ListOfferings) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/ListOfferings) + [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/ListOfferings) + [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/ListOfferings) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/ListOfferings) + [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/ListOfferings) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/ListOfferings) + [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/ListOfferings) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/ListOfferings)