[ aws . ec2 ]

create-capacity-reservation-date-change-quote

Description

Generates a quote for changing the start date of a future-dated Capacity Reservation that has not yet been delivered. The quote includes the new start date, the resulting commitment end date, and a quote ID. Pass the quote ID to ModifyCapacityReservation to apply the change.

The cumulative pushout across all changes is limited to 30 days from the Capacity Reservation’s original start date. Quotes are valid for 24 hours, and always expire at least one hour before the start date.

See also: AWS API Documentation

Synopsis

  create-capacity-reservation-date-change-quote
--capacity-reservation-id <value>
--new-start-date <value>
[--client-token <value>]
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
[--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

--capacity-reservation-id (string) [required]

The ID of the Capacity Reservation.

--new-start-date (timestamp) [required]

The requested new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ ). The new start date must be later than the current start date and within the cumulative 30-day pushout limit.

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency .

--tag-specifications (list)

The tags to apply to the date change quote.

(structure)

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

ResourceType -> (string)

The type of resource to tag on creation.

Possible values:

• capacity-reservation
• client-vpn-endpoint
• customer-gateway
• carrier-gateway
• coip-pool
• declarative-policies-report
• dedicated-host
• dhcp-options
• egress-only-internet-gateway
• elastic-ip
• elastic-gpu
• export-image-task
• export-instance-task
• fleet
• fpga-image
• host-reservation
• image
• image-usage-report
• import-image-task
• import-snapshot-task
• instance
• instance-event-window
• internet-gateway
• ipam
• ipam-pool
• ipam-scope
• ipv4pool-ec2
• ipv6pool-ec2
• key-pair
• launch-template
• local-gateway
• local-gateway-route-table
• local-gateway-virtual-interface
• local-gateway-virtual-interface-group
• local-gateway-route-table-vpc-association
• local-gateway-route-table-virtual-interface-group-association
• natgateway
• network-acl
• network-interface
• network-insights-analysis
• network-insights-path
• network-insights-access-scope
• network-insights-access-scope-analysis
• outpost-lag
• placement-group
• prefix-list
• replace-root-volume-task
• reserved-instances
• route-table
• security-group
• security-group-rule
• service-link-virtual-interface
• snapshot
• spot-fleet-request
• spot-instances-request
• subnet
• subnet-cidr-reservation
• traffic-mirror-filter
• traffic-mirror-session
• traffic-mirror-target
• transit-gateway
• transit-gateway-attachment
• transit-gateway-connect-peer
• transit-gateway-multicast-domain
• transit-gateway-policy-table
• transit-gateway-metering-policy
• transit-gateway-route-table
• transit-gateway-route-table-announcement
• volume
• vpc
• vpc-endpoint
• vpc-endpoint-connection
• vpc-endpoint-service
• vpc-endpoint-service-permission
• vpc-peering-connection
• vpn-connection
• vpn-gateway
• vpc-flow-log
• capacity-reservation-fleet
• traffic-mirror-filter-rule
• vpc-endpoint-connection-device-type
• verified-access-instance
• verified-access-group
• verified-access-endpoint
• verified-access-policy
• verified-access-trust-provider
• vpn-connection-device-type
• vpc-block-public-access-exclusion
• vpc-encryption-control
• route-server
• route-server-endpoint
• route-server-peer
• ipam-resource-discovery
• ipam-resource-discovery-association
• instance-connect-endpoint
• verified-access-endpoint-target
• ipam-external-resource-verification-token
• capacity-block
• mac-modification-task
• ipam-prefix-list-resolver
• ipam-policy
• ipam-prefix-list-resolver-target
• ipam-internet-registry-association
• secondary-interface
• secondary-network
• secondary-subnet
• capacity-manager-data-export
• vpn-concentrator
• ipam-pool-allocation
• capacity-reservation-cancellation-quote
• application-status-check
• capacity-reservation-modification-quote

Tags -> (list)

The tags to apply to the resource.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"ipam-internet-registry-association"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation"|"capacity-reservation-cancellation-quote"|"application-status-check"|"capacity-reservation-modification-quote",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

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 DryRunOperation . Otherwise, it is UnauthorizedOperation .

--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

CapacityReservationModificationQuote -> (structure)

Information about the Capacity Reservation date change quote.

CapacityReservationModificationQuoteId -> (string)

The ID of the modification quote.

CapacityReservationId -> (string)

The ID of the Capacity Reservation associated with the modification quote.

CreateTime -> (timestamp)

The date and time at which the modification quote was created.

ExpirationTime -> (timestamp)

The date and time at which the modification quote expires.

QuoteState -> (string)

The state of the modification quote itself. Possible values are:

• active - The quote can still be used.
• expired - The quote can no longer be used. A quote becomes expired at its expirationTime .

Possible values:

• active
• expired

CurrentConfiguration -> (structure)

The configuration that the Capacity Reservation has at the time the quote was generated.

InstanceCount -> (integer)

The number of instances in the Capacity Reservation.

ReservationState -> (string)

The current state of the Capacity Reservation.

StartDate -> (timestamp)

The start date that the Capacity Reservation has before the quoted modification is applied.

OriginalStartDate -> (timestamp)

The start date that the Capacity Reservation was originally requested with. This value does not change when you push out the start date.

ModificationTerms -> (structure)

The terms of the modification, including the configuration that the Capacity Reservation will have if you accept them by using ModifyCapacityReservation .

ReservationUpdate -> (structure)

The changes that will be applied to the Capacity Reservation if you accept the modification terms.

NewCommitmentEndDate -> (timestamp)

The date and time at which the commitment duration will expire after the modification, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ ).

NewStartDate -> (timestamp)

The start date that the Capacity Reservation will have after the modification, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ ).

NewCommitmentDuration -> (integer)

The commitment duration, in seconds, that the Capacity Reservation will have after the modification.

Tags -> (list)

The tags assigned to the modification quote.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.