create_capacity_reservation async ¶

async def create_capacity_reservation(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    instance_type: Optional["capo_ec2.types.string.String"] = None,
    instance_platform: Optional[
        "capo_ec2.types.capacity_reservation_instance_platform.CapacityReservationInstancePlatform"
    ] = None,
    availability_zone: Optional[
        "capo_ec2.types.availability_zone_name.AvailabilityZoneName"
    ] = None,
    availability_zone_id: Optional[
        "capo_ec2.types.availability_zone_id.AvailabilityZoneId"
    ] = None,
    tenancy: Optional[
        "capo_ec2.types.capacity_reservation_tenancy.CapacityReservationTenancy"
    ] = None,
    instance_count: Optional["capo_ec2.types.integer.Integer"] = None,
    ebs_optimized: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ephemeral_storage: Optional["capo_ec2.types.boolean.Boolean"] = None,
    end_date: Optional["capo_ec2.types.date_time.DateTime"] = None,
    end_date_type: Optional["capo_ec2.types.end_date_type.EndDateType"] = None,
    instance_match_criteria: Optional[
        "capo_ec2.types.instance_match_criteria.InstanceMatchCriteria"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    outpost_arn: Optional["capo_ec2.types.outpost_arn.OutpostArn"] = None,
    placement_group_arn: Optional[
        "capo_ec2.types.placement_group_arn.PlacementGroupArn"
    ] = None,
    start_date: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = None,
    commitment_duration: Optional[
        "capo_ec2.types.capacity_reservation_commitment_duration.CapacityReservationCommitmentDuration"
    ] = None,
    delivery_preference: Optional[
        "capo_ec2.types.capacity_reservation_delivery_preference.CapacityReservationDeliveryPreference"
    ] = None,
) -> "capo_ec2.types.create_capacity_reservation_result.CreateCapacityReservationResult":
    """<p>Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration.</p> <p>You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html"> Reserve compute capacity with On-Demand Capacity Reservations</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>Your request to create a Capacity Reservation could fail if:</p> <ul> <li> <p>Amazon EC2 does not have sufficient capacity. In this case, try again at a later time, try in a different Availability Zone, or request a smaller Capacity Reservation. If your workload is flexible across instance types and sizes, try with different instance attributes.</p> </li> <li> <p>The requested quantity exceeds your On-Demand Instance quota. In this case, increase your On-Demand Instance quota for the requested instance type and try again. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html"> Amazon EC2 Service Quotas</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> </ul>

    Args:
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensure Idempotency</a>.</p>
        instance_type: <p>The instance type for which to reserve capacity.</p> <note> <p>You can request future-dated Capacity Reservations for instance types in the C, M, R, I, T, and G instance families only.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>.</p>
        instance_platform: <p>The type of operating system for which to reserve capacity.</p>
        availability_zone: <p>The Availability Zone in which to create the Capacity Reservation.</p>
        availability_zone_id: <p>The ID of the Availability Zone in which to create the Capacity Reservation.</p>
        tenancy: <p>Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul>
        instance_count: <p>The number of instances for which to reserve capacity.</p> <note> <p>You can request future-dated Capacity Reservations for an instance count with a minimum of 32 vCPUs. For example, if you request a future-dated Capacity Reservation for <code>m5.xlarge</code> instances, you must request at least 8 instances (<i>8 * m5.xlarge = 32 vCPUs</i>).</p> </note> <p>Valid range: 1 - 1000</p>
        ebs_optimized: <p>Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.</p>
        ephemeral_storage: <p> <i>Deprecated.</i> </p>
        end_date: <p>The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to <code>expired</code> when it reaches its end date and time.</p> <p>You must provide an <code>EndDate</code> value if <code>EndDateType</code> is <code>limited</code>. Omit <code>EndDate</code> if <code>EndDateType</code> is <code>unlimited</code>.</p> <p>If the <code>EndDateType</code> is <code>limited</code>, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.</p> <p>If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.</p>
        end_date_type: <p>Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p> <ul> <li> <p> <code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an <code>EndDate</code> if the <code>EndDateType</code> is <code>unlimited</code>.</p> </li> <li> <p> <code>limited</code> - The Capacity Reservation expires automatically at a specified date and time. You must provide an <code>EndDate</code> value if the <code>EndDateType</code> value is <code>limited</code>.</p> </li> </ul>
        instance_match_criteria: <p>Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p> <ul> <li> <p> <code>open</code> - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.</p> </li> <li> <p> <code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. </p> </li> </ul> <note> <p>If you are requesting a future-dated Capacity Reservation, you must specify <code>targeted</code>.</p> </note> <p>Default: <code>open</code> </p>
        tag_specifications: <p>The tags to apply to the Capacity Reservation during launch.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        outpost_arn: <note> <p>Not supported for future-dated Capacity Reservations.</p> </note> <p>The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.</p>
        placement_group_arn: <note> <p>Not supported for future-dated Capacity Reservations.</p> </note> <p>The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html"> Capacity Reservations for cluster placement groups</a> in the <i>Amazon EC2 User Guide</i>.</p>
        start_date: <note> <p>Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter. </p> </note> <p>The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>).</p> <p>You can request a future-dated Capacity Reservation between 5 and 120 days in advance.</p>
        commitment_duration: <note> <p>Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter. </p> </note> <p>Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.</p> <p>The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the <code>active</code> state in your account after it has been delivered.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-concepts.html#cr-commitment-duration"> Commitment duration</a>.</p>
        delivery_preference: <note> <p>Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter. </p> </note> <p>Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.</p> <p>The only supported value is <code>incremental</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.create_capacity_reservation_request.CreateCapacityReservationRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.create_capacity_reservation_result.CreateCapacityReservationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_capacity_reservation

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.create_capacity_reservation.async_create_capacity_reservation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCapacityReservation")
    )
    input_: capo_ec2.types.create_capacity_reservation_request.CreateCapacityReservationRequest = {}
    if client_token is not None:
        input_["client_token"] = client_token
    if instance_type is not None:
        input_["instance_type"] = instance_type
    if instance_platform is not None:
        input_["instance_platform"] = instance_platform
    if availability_zone is not None:
        input_["availability_zone"] = availability_zone
    if availability_zone_id is not None:
        input_["availability_zone_id"] = availability_zone_id
    if tenancy is not None:
        input_["tenancy"] = tenancy
    if instance_count is not None:
        input_["instance_count"] = instance_count
    if ebs_optimized is not None:
        input_["ebs_optimized"] = ebs_optimized
    if ephemeral_storage is not None:
        input_["ephemeral_storage"] = ephemeral_storage
    if end_date is not None:
        input_["end_date"] = end_date
    if end_date_type is not None:
        input_["end_date_type"] = end_date_type
    if instance_match_criteria is not None:
        input_["instance_match_criteria"] = instance_match_criteria
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if outpost_arn is not None:
        input_["outpost_arn"] = outpost_arn
    if placement_group_arn is not None:
        input_["placement_group_arn"] = placement_group_arn
    if start_date is not None:
        input_["start_date"] = start_date
    if commitment_duration is not None:
        input_["commitment_duration"] = commitment_duration
    if delivery_preference is not None:
        input_["delivery_preference"] = delivery_preference

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output