get-enterprise-support-contract-details¶
Synopsis¶
get-enterprise-support-contract-details
--billing-month <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
Options¶
--billing-month (string) [required]
The billing month in YYYY-MM format. This must be a month in the past.
Constraints:
- pattern:
\d{4}-(0[1-9]|1[0-2])
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
- off
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
- legacy
- json
- yaml
- text
- table
- enhanced
Output¶
isContractActive -> (boolean)
When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.
supportAllocationMethod -> (string)
The method used to distribute the total Support charge amount across each account in the Support profile. Valid values: Proportional, Fixed_Percentage. Proportional means support charges are distributed to each account in proportion to its eligible Spend. Fixed_Percentage means support charges are distributed across accounts according to pre-configured percentages from the contract.
supportReservedInstanceAmortizationStartDate -> (timestamp)
When supportReservedInstanceTreatmentMethod = AmortizedCustom, only amortized fees for Reserved Instances purchased on or after this date are included in the calculation. This field is Null for all other treatment methods.
supportReservedInstanceTreatmentMethod -> (string)
The method used to include Reserved Instance (RI) fees in the Enterprise Support charge calculation. Valid values: None (RI fees excluded from Support-eligible spend), Upfront (full upfront RI fees included in month of purchase), Amortized (RI fees spread over commitment term for RIs purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for RIs purchased on or after a specified custom start date), AmortizedAll (RI fees amortized for all active RIs including those purchased before Support subscription started).
supportSavingsPlansAmortizationStartDate -> (timestamp)
This is applicable when supportSavingsPlansTreatmentMethod = Amortized and is Null for all other methods. It shows the start date from which Savings Plan fees are included in Support Eligible Spend.
supportSavingsPlansTreatmentMethod -> (string)
The method used to include Savings Plans fees in Enterprise Support charge calculations. Valid values: None (Savings Plan fees excluded from Support-eligible spend), Upfront (full upfront Savings Plan fees included in month of purchase), Amortized (Savings Plan fees spread over commitment term for Savings Plans purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for Savings Plans purchased on or after a specified custom start date), AmortizedAll (Savings Plan fees amortized for all active Savings Plans including those purchased before Support subscription started).
supportProrateStartDate -> (timestamp)
The start date for accounts subscribed or unsubscribed to Support billing during the billing month.
contractPayerAccountIds -> (list)
The list of accounts covered by the Enterprise Support contract.
Constraints:
- min:
0- max:
2000(structure)
An account that is covered by the Enterprise Support contract.
accountId -> (string) [required]
The account ID.
Constraints:
- pattern:
[0-9]{12}isGdn -> (boolean) [required]
When true, Support charges are calculated on charges before private discounts. When false, they are calculated after private discounts.
chargedPayerAccountIds -> (list)
The list of payer accounts and their charge allocation percentages.
Constraints:
- min:
0- max:
1000(structure)
An account that is charged all or a portion of the total Support charge and the percentage of the charge allocated to it.
accountId -> (string) [required]
The account ID.
Constraints:
- pattern:
[0-9]{12}chargePercentage -> (string) [required]
The percentage of the total Support charge allocated to this account. This is 0.0 when supportAllocationMethod = Proportional.
additionalSupportCharge -> (list)
Any Additional support charges applied to the contract.
Constraints:
- min:
0- max:
50(structure)
An additional charge applied to an Enterprise Support contract.
description -> (string) [required]
A description of the additional charge.amount -> (string)
The charge amount.chargeType -> (string)
The type of additional charge.
additionalSupportEligibleUsageSpend -> (list)
Any Additional support-eligible usage spend charges.
Constraints:
- min:
0- max:
50(structure)
An additional charge applied to an Enterprise Support contract.
description -> (string) [required]
A description of the additional charge.amount -> (string)
The charge amount.chargeType -> (string)
The type of additional charge.
pricingPlans -> (list)
The pricing plans associated with this Enterprise Support contract.
Constraints:
- min:
0- max:
10(structure)
A pricing plan for Enterprise Support billing.
pricingPlanId -> (string)
The unique identifier for the pricing plan.name -> (string)
The name of the pricing plan.description -> (string)
A description of the pricing plan.startDate -> (timestamp)
The start date of the pricing plan.endDate -> (timestamp)
The end date of the pricing plan.planDiscountPercent -> (string)
The discount percentage applied by this pricing plan.discountAppliesToMinimumCharge -> (boolean)
Whether the discount applies to the minimum Support charge.minimumCharge -> (string)
The minimum Support charge amount for this pricing plan.tiered -> (string)
Whether the pricing plan uses tiered pricing.tiers -> (list) [required]
The pricing tiers within this plan.
Constraints:
- min:
0- max:
20(structure)
A tier within an Enterprise Support pricing plan.
tierMinimum -> (string) [required]
The minimum spend threshold for this tier.tierMaximum -> (string)
The maximum spend threshold for this tier.baseCharge -> (string) [required]
The base charge for this tier.additionalPercentageOfAggregateCharges -> (string) [required]
The additional percentage applied to aggregate charges in this tier.aggregateChargesAdjustment -> (string) [required]
The adjustment applied to aggregate charges.incremental -> (boolean) [required]
Whether the tier charges are calculated incrementally.increment -> (string)
The increment amount for incremental tier calculations.incrementCharge -> (string)
The charge per increment.