:doc:`BillingandCostManagementPricingCalculator <../../bcm-pricing-calculator>` / Client / create_bill_scenario

********************
create_bill_scenario
********************



.. py:method:: BillingandCostManagementPricingCalculator.Client.create_bill_scenario(**kwargs)

  

  Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bcm-pricing-calculator-2024-06-19/CreateBillScenario>`_  


  **Request Syntax**
  ::

    response = client.create_bill_scenario(
        name='string',
        clientToken='string',
        tags={
            'string': 'string'
        },
        groupSharingPreference='OPEN'|'PRIORITIZED'|'RESTRICTED',
        costCategoryGroupSharingPreferenceArn='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    A descriptive name for the bill scenario.

    

  
  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  
  :type tags: dict
  :param tags: 

    The tags to apply to the bill scenario.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type groupSharingPreference: string
  :param groupSharingPreference: 

    The setting for the reserved instance and savings plan group sharing used in this estimate.

    

  
  :type costCategoryGroupSharingPreferenceArn: string
  :param costCategoryGroupSharingPreferenceArn: 

    The arn of the cost category used in the reserved and prioritized group sharing.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'id': 'string',
          'name': 'string',
          'billInterval': {
              'start': datetime(2015, 1, 1),
              'end': datetime(2015, 1, 1)
          },
          'status': 'READY'|'LOCKED'|'FAILED'|'STALE',
          'createdAt': datetime(2015, 1, 1),
          'expiresAt': datetime(2015, 1, 1),
          'failureMessage': 'string',
          'groupSharingPreference': 'OPEN'|'PRIORITIZED'|'RESTRICTED',
          'costCategoryGroupSharingPreferenceArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The unique identifier for the created bill scenario.

        
      

      - **name** *(string) --* 

        The name of the created bill scenario.

        
      

      - **billInterval** *(dict) --* 

        The time period covered by the bill scenario.

        
        

        - **start** *(datetime) --* 

          The start date and time of the interval.

          
        

        - **end** *(datetime) --* 

          The end date and time of the interval.

          
    
      

      - **status** *(string) --* 

        The current status of the bill scenario.

        
      

      - **createdAt** *(datetime) --* 

        The timestamp when the bill scenario was created.

        
      

      - **expiresAt** *(datetime) --* 

        The timestamp when the bill scenario will expire.

        
      

      - **failureMessage** *(string) --* 

        An error message if the bill scenario creation failed.

        
      

      - **groupSharingPreference** *(string) --* 

        The setting for the reserved instance and savings plan group sharing used in this estimate.

        
      

      - **costCategoryGroupSharingPreferenceArn** *(string) --* 

        The arn of the cost category used in the reserved and prioritized group sharing.

        
  
  **Exceptions**
  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ConflictException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ValidationException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.DataUnavailableException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.InternalServerException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ThrottlingException`

  