2025/10/15 - Amazon Elastic Compute Cloud - 9 new9 updated api methods
Changes Introducing EC2 Capacity Manager for monitoring and analyzing capacity usage across On-Demand Instances, Spot Instances, and Capacity Reservations.
Deletes an existing Capacity Manager data export configuration. This stops future scheduled exports but does not delete previously exported files from S3.
See also: AWS API Documentation
Request Syntax
client.delete_capacity_manager_data_export(
CapacityManagerDataExportId='string',
DryRun=True|False
)
string
[REQUIRED]
The unique identifier of the data export configuration to delete.
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.
dict
Response Syntax
{
'CapacityManagerDataExportId': 'string'
}
Response Structure
(dict) --
CapacityManagerDataExportId (string) --
The unique identifier of the deleted data export configuration.
Disables EC2 Capacity Manager for your account. This stops data ingestion and removes access to capacity analytics and optimization recommendations. Previously collected data is retained but no new data will be processed.
See also: AWS API Documentation
Request Syntax
client.disable_capacity_manager(
DryRun=True|False,
ClientToken='string'
)
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CapacityManagerStatus': 'enabled'|'disabled',
'OrganizationsAccess': True|False
}
Response Structure
(dict) --
CapacityManagerStatus (string) --
The current status of Capacity Manager after the disable operation.
OrganizationsAccess (boolean) --
Indicates whether Organizations access is enabled. This will be false after disabling Capacity Manager.
Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Web Services Organization or only from the current account.
See also: AWS API Documentation
Request Syntax
client.update_capacity_manager_organizations_access(
OrganizationsAccess=True|False,
DryRun=True|False,
ClientToken='string'
)
boolean
[REQUIRED]
Specifies whether to enable or disable cross-account access for Amazon Web Services Organizations. When enabled, Capacity Manager aggregates data from all accounts in your organization.
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CapacityManagerStatus': 'enabled'|'disabled',
'OrganizationsAccess': True|False
}
Response Structure
(dict) --
CapacityManagerStatus (string) --
The current status of Capacity Manager after the update operation.
OrganizationsAccess (boolean) --
The updated Organizations access setting indicating whether cross-account data aggregation is enabled.
Retrieves capacity usage metrics for your EC2 resources. Returns time-series data for metrics like unused capacity, utilization rates, and costs across On-Demand, Spot, and Capacity Reservations. Data can be grouped and filtered by various dimensions such as region, account, and instance family.
See also: AWS API Documentation
Request Syntax
client.get_capacity_manager_metric_data(
MetricNames=[
'reservation-total-capacity-hrs-vcpu'|'reservation-total-capacity-hrs-inst'|'reservation-max-size-vcpu'|'reservation-max-size-inst'|'reservation-min-size-vcpu'|'reservation-min-size-inst'|'reservation-unused-total-capacity-hrs-vcpu'|'reservation-unused-total-capacity-hrs-inst'|'reservation-unused-total-estimated-cost'|'reservation-max-unused-size-vcpu'|'reservation-max-unused-size-inst'|'reservation-min-unused-size-vcpu'|'reservation-min-unused-size-inst'|'reservation-max-utilization'|'reservation-min-utilization'|'reservation-avg-utilization-vcpu'|'reservation-avg-utilization-inst'|'reservation-total-count'|'reservation-total-estimated-cost'|'reservation-avg-future-size-vcpu'|'reservation-avg-future-size-inst'|'reservation-min-future-size-vcpu'|'reservation-min-future-size-inst'|'reservation-max-future-size-vcpu'|'reservation-max-future-size-inst'|'reservation-avg-committed-size-vcpu'|'reservation-avg-committed-size-inst'|'reservation-max-committed-size-vcpu'|'reservation-max-committed-size-inst'|'reservation-min-committed-size-vcpu'|'reservation-min-committed-size-inst'|'reserved-total-usage-hrs-vcpu'|'reserved-total-usage-hrs-inst'|'reserved-total-estimated-cost'|'unreserved-total-usage-hrs-vcpu'|'unreserved-total-usage-hrs-inst'|'unreserved-total-estimated-cost'|'spot-total-usage-hrs-vcpu'|'spot-total-usage-hrs-inst'|'spot-total-estimated-cost'|'spot-avg-run-time-before-interruption-inst'|'spot-max-run-time-before-interruption-inst'|'spot-min-run-time-before-interruption-inst',
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Period=123,
GroupBy=[
'resource-region'|'availability-zone-id'|'account-id'|'instance-family'|'instance-type'|'instance-platform'|'reservation-arn'|'reservation-id'|'reservation-type'|'reservation-create-timestamp'|'reservation-start-timestamp'|'reservation-end-timestamp'|'reservation-end-date-type'|'tenancy'|'reservation-state'|'reservation-instance-match-criteria'|'reservation-unused-financial-owner',
],
FilterBy=[
{
'DimensionCondition': {
'Dimension': 'resource-region'|'availability-zone-id'|'account-id'|'instance-family'|'instance-type'|'instance-platform'|'reservation-arn'|'reservation-id'|'reservation-type'|'reservation-create-timestamp'|'reservation-start-timestamp'|'reservation-end-timestamp'|'reservation-end-date-type'|'tenancy'|'reservation-state'|'reservation-instance-match-criteria'|'reservation-unused-financial-owner',
'Comparison': 'equals'|'in',
'Values': [
'string',
]
}
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
[REQUIRED]
The names of the metrics to retrieve. Maximum of 10 metrics per request.
(string) --
datetime
[REQUIRED]
The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.
datetime
[REQUIRED]
The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.
integer
[REQUIRED]
The granularity, in seconds, of the returned data points.
list
The dimensions by which to group the metric data. This determines how the data is aggregated and returned.
(string) --
list
Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.
(dict) --
Represents a filter condition for Capacity Manager queries. Contains dimension-based filtering criteria used to narrow down metric data and dimension results.
DimensionCondition (dict) --
The dimension-based condition that specifies how to filter the data based on dimension values.
Dimension (string) --
The name of the dimension to filter by.
Comparison (string) --
The comparison operator to use for the filter.
Values (list) --
The list of values to match against the specified dimension. For 'equals' comparison, only the first value is used. For 'in' comparison, any matching value will satisfy the condition.
(string) --
integer
The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.
string
The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.
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.
dict
Response Syntax
{
'MetricDataResults': [
{
'Dimension': {
'ResourceRegion': 'string',
'AvailabilityZoneId': 'string',
'AccountId': 'string',
'InstanceFamily': 'string',
'InstanceType': 'string',
'InstancePlatform': 'string',
'ReservationArn': 'string',
'ReservationId': 'string',
'ReservationType': 'capacity-block'|'odcr',
'ReservationCreateTimestamp': datetime(2015, 1, 1),
'ReservationStartTimestamp': datetime(2015, 1, 1),
'ReservationEndTimestamp': datetime(2015, 1, 1),
'ReservationEndDateType': 'limited'|'unlimited',
'Tenancy': 'default'|'dedicated',
'ReservationState': 'active'|'expired'|'cancelled'|'scheduled'|'pending'|'failed'|'delayed'|'unsupported'|'payment-pending'|'payment-failed'|'retired',
'ReservationInstanceMatchCriteria': 'string',
'ReservationUnusedFinancialOwner': 'string'
},
'Timestamp': datetime(2015, 1, 1),
'MetricValues': [
{
'Metric': 'reservation-total-capacity-hrs-vcpu'|'reservation-total-capacity-hrs-inst'|'reservation-max-size-vcpu'|'reservation-max-size-inst'|'reservation-min-size-vcpu'|'reservation-min-size-inst'|'reservation-unused-total-capacity-hrs-vcpu'|'reservation-unused-total-capacity-hrs-inst'|'reservation-unused-total-estimated-cost'|'reservation-max-unused-size-vcpu'|'reservation-max-unused-size-inst'|'reservation-min-unused-size-vcpu'|'reservation-min-unused-size-inst'|'reservation-max-utilization'|'reservation-min-utilization'|'reservation-avg-utilization-vcpu'|'reservation-avg-utilization-inst'|'reservation-total-count'|'reservation-total-estimated-cost'|'reservation-avg-future-size-vcpu'|'reservation-avg-future-size-inst'|'reservation-min-future-size-vcpu'|'reservation-min-future-size-inst'|'reservation-max-future-size-vcpu'|'reservation-max-future-size-inst'|'reservation-avg-committed-size-vcpu'|'reservation-avg-committed-size-inst'|'reservation-max-committed-size-vcpu'|'reservation-max-committed-size-inst'|'reservation-min-committed-size-vcpu'|'reservation-min-committed-size-inst'|'reserved-total-usage-hrs-vcpu'|'reserved-total-usage-hrs-inst'|'reserved-total-estimated-cost'|'unreserved-total-usage-hrs-vcpu'|'unreserved-total-usage-hrs-inst'|'unreserved-total-estimated-cost'|'spot-total-usage-hrs-vcpu'|'spot-total-usage-hrs-inst'|'spot-total-estimated-cost'|'spot-avg-run-time-before-interruption-inst'|'spot-max-run-time-before-interruption-inst'|'spot-min-run-time-before-interruption-inst',
'Value': 123.0
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricDataResults (list) --
The metric data points returned by the query. Each result contains dimension values, timestamp, and metric values with their associated statistics.
(dict) --
Contains a single data point from a capacity metrics query, including the dimension values, timestamp, and metric values for that specific combination.
Dimension (dict) --
The dimension values that identify this specific data point, such as account ID, region, and instance family.
ResourceRegion (string) --
The Amazon Web Services Region where the capacity resource is located.
AvailabilityZoneId (string) --
The unique identifier of the Availability Zone where the capacity resource is located.
AccountId (string) --
The Amazon Web Services account ID that owns the capacity resource.
InstanceFamily (string) --
The EC2 instance family of the capacity resource.
InstanceType (string) --
The specific EC2 instance type of the capacity resource.
InstancePlatform (string) --
The platform or operating system of the instance.
ReservationArn (string) --
The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.
ReservationId (string) --
The unique identifier of the capacity reservation.
ReservationType (string) --
The type of capacity reservation.
ReservationCreateTimestamp (datetime) --
The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.
ReservationStartTimestamp (datetime) --
The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.
ReservationEndTimestamp (datetime) --
The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.
ReservationEndDateType (string) --
The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
Tenancy (string) --
The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
ReservationState (string) --
The current state of the capacity reservation.
ReservationInstanceMatchCriteria (string) --
The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.
ReservationUnusedFinancialOwner (string) --
The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.
Timestamp (datetime) --
The timestamp for this data point, indicating when the capacity usage occurred.
MetricValues (list) --
The metric values and statistics for this data point, containing the actual capacity usage numbers.
(dict) --
Represents a single metric value with its associated statistic, such as the sum or average of unused capacity hours.
Metric (string) --
The name of the metric.
Value (float) --
The numerical value of the metric for the specified statistic and time period.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Retrieves the current configuration and status of EC2 Capacity Manager for your account, including enablement status, Organizations access settings, and data ingestion status.
See also: AWS API Documentation
Request Syntax
client.get_capacity_manager_attributes(
DryRun=True|False
)
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.
dict
Response Syntax
{
'CapacityManagerStatus': 'enabled'|'disabled',
'OrganizationsAccess': True|False,
'DataExportCount': 123,
'IngestionStatus': 'initial-ingestion-in-progress'|'ingestion-complete'|'ingestion-failed',
'IngestionStatusMessage': 'string',
'EarliestDatapointTimestamp': datetime(2015, 1, 1),
'LatestDatapointTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CapacityManagerStatus (string) --
The current status of Capacity Manager.
OrganizationsAccess (boolean) --
Indicates whether Organizations access is enabled for cross-account data aggregation.
DataExportCount (integer) --
The number of active data export configurations for this account. This count includes all data exports regardless of their current delivery status.
IngestionStatus (string) --
The current data ingestion status. Initial ingestion may take several hours after enabling Capacity Manager.
IngestionStatusMessage (string) --
A descriptive message providing additional details about the current ingestion status. This may include error information if ingestion has failed or progress details during initial setup.
EarliestDatapointTimestamp (datetime) --
The timestamp of the earliest data point available in Capacity Manager, in milliseconds since epoch. This indicates how far back historical data is available for queries.
LatestDatapointTimestamp (datetime) --
The timestamp of the most recent data point ingested by Capacity Manager, in milliseconds since epoch. This indicates how current your capacity data is.
Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.
See also: AWS API Documentation
Request Syntax
client.get_capacity_manager_metric_dimensions(
GroupBy=[
'resource-region'|'availability-zone-id'|'account-id'|'instance-family'|'instance-type'|'instance-platform'|'reservation-arn'|'reservation-id'|'reservation-type'|'reservation-create-timestamp'|'reservation-start-timestamp'|'reservation-end-timestamp'|'reservation-end-date-type'|'tenancy'|'reservation-state'|'reservation-instance-match-criteria'|'reservation-unused-financial-owner',
],
FilterBy=[
{
'DimensionCondition': {
'Dimension': 'resource-region'|'availability-zone-id'|'account-id'|'instance-family'|'instance-type'|'instance-platform'|'reservation-arn'|'reservation-id'|'reservation-type'|'reservation-create-timestamp'|'reservation-start-timestamp'|'reservation-end-timestamp'|'reservation-end-date-type'|'tenancy'|'reservation-state'|'reservation-instance-match-criteria'|'reservation-unused-financial-owner',
'Comparison': 'equals'|'in',
'Values': [
'string',
]
}
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MetricNames=[
'reservation-total-capacity-hrs-vcpu'|'reservation-total-capacity-hrs-inst'|'reservation-max-size-vcpu'|'reservation-max-size-inst'|'reservation-min-size-vcpu'|'reservation-min-size-inst'|'reservation-unused-total-capacity-hrs-vcpu'|'reservation-unused-total-capacity-hrs-inst'|'reservation-unused-total-estimated-cost'|'reservation-max-unused-size-vcpu'|'reservation-max-unused-size-inst'|'reservation-min-unused-size-vcpu'|'reservation-min-unused-size-inst'|'reservation-max-utilization'|'reservation-min-utilization'|'reservation-avg-utilization-vcpu'|'reservation-avg-utilization-inst'|'reservation-total-count'|'reservation-total-estimated-cost'|'reservation-avg-future-size-vcpu'|'reservation-avg-future-size-inst'|'reservation-min-future-size-vcpu'|'reservation-min-future-size-inst'|'reservation-max-future-size-vcpu'|'reservation-max-future-size-inst'|'reservation-avg-committed-size-vcpu'|'reservation-avg-committed-size-inst'|'reservation-max-committed-size-vcpu'|'reservation-max-committed-size-inst'|'reservation-min-committed-size-vcpu'|'reservation-min-committed-size-inst'|'reserved-total-usage-hrs-vcpu'|'reserved-total-usage-hrs-inst'|'reserved-total-estimated-cost'|'unreserved-total-usage-hrs-vcpu'|'unreserved-total-usage-hrs-inst'|'unreserved-total-estimated-cost'|'spot-total-usage-hrs-vcpu'|'spot-total-usage-hrs-inst'|'spot-total-estimated-cost'|'spot-avg-run-time-before-interruption-inst'|'spot-max-run-time-before-interruption-inst'|'spot-min-run-time-before-interruption-inst',
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
[REQUIRED]
The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.
(string) --
list
Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.
(dict) --
Represents a filter condition for Capacity Manager queries. Contains dimension-based filtering criteria used to narrow down metric data and dimension results.
DimensionCondition (dict) --
The dimension-based condition that specifies how to filter the data based on dimension values.
Dimension (string) --
The name of the dimension to filter by.
Comparison (string) --
The comparison operator to use for the filter.
Values (list) --
The list of values to match against the specified dimension. For 'equals' comparison, only the first value is used. For 'in' comparison, any matching value will satisfy the condition.
(string) --
datetime
[REQUIRED]
The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.
datetime
[REQUIRED]
The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.
list
[REQUIRED]
The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.
(string) --
integer
The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.
string
The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.
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.
dict
Response Syntax
{
'MetricDimensionResults': [
{
'ResourceRegion': 'string',
'AvailabilityZoneId': 'string',
'AccountId': 'string',
'InstanceFamily': 'string',
'InstanceType': 'string',
'InstancePlatform': 'string',
'ReservationArn': 'string',
'ReservationId': 'string',
'ReservationType': 'capacity-block'|'odcr',
'ReservationCreateTimestamp': datetime(2015, 1, 1),
'ReservationStartTimestamp': datetime(2015, 1, 1),
'ReservationEndTimestamp': datetime(2015, 1, 1),
'ReservationEndDateType': 'limited'|'unlimited',
'Tenancy': 'default'|'dedicated',
'ReservationState': 'active'|'expired'|'cancelled'|'scheduled'|'pending'|'failed'|'delayed'|'unsupported'|'payment-pending'|'payment-failed'|'retired',
'ReservationInstanceMatchCriteria': 'string',
'ReservationUnusedFinancialOwner': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricDimensionResults (list) --
The available dimension combinations that have data within the specified time range and filters.
(dict) --
Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data.
ResourceRegion (string) --
The Amazon Web Services Region where the capacity resource is located.
AvailabilityZoneId (string) --
The unique identifier of the Availability Zone where the capacity resource is located.
AccountId (string) --
The Amazon Web Services account ID that owns the capacity resource.
InstanceFamily (string) --
The EC2 instance family of the capacity resource.
InstanceType (string) --
The specific EC2 instance type of the capacity resource.
InstancePlatform (string) --
The platform or operating system of the instance.
ReservationArn (string) --
The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.
ReservationId (string) --
The unique identifier of the capacity reservation.
ReservationType (string) --
The type of capacity reservation.
ReservationCreateTimestamp (datetime) --
The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.
ReservationStartTimestamp (datetime) --
The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.
ReservationEndTimestamp (datetime) --
The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.
ReservationEndDateType (string) --
The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
Tenancy (string) --
The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
ReservationState (string) --
The current state of the capacity reservation.
ReservationInstanceMatchCriteria (string) --
The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.
ReservationUnusedFinancialOwner (string) --
The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.
See also: AWS API Documentation
Request Syntax
client.describe_capacity_manager_data_exports(
CapacityManagerDataExportIds=[
'string',
],
MaxResults=123,
NextToken='string',
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
list
The IDs of the data export configurations to describe. If not specified, all export configurations are returned.
(string) --
integer
The maximum number of results to return in a single call. If not specified, up to 1000 results are returned.
string
The token for the next page of results. Use this value in a subsequent call to retrieve additional results.
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.
list
One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'CapacityManagerDataExports': [
{
'CapacityManagerDataExportId': 'string',
'S3BucketName': 'string',
'S3BucketPrefix': 'string',
'Schedule': 'hourly',
'OutputFormat': 'csv'|'parquet',
'CreateTime': datetime(2015, 1, 1),
'LatestDeliveryStatus': 'pending'|'in-progress'|'delivered'|'failed',
'LatestDeliveryStatusMessage': 'string',
'LatestDeliveryS3LocationUri': 'string',
'LatestDeliveryTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CapacityManagerDataExports (list) --
Information about the data export configurations, including export settings, delivery status, and recent activity.
(dict) --
Contains information about a Capacity Manager data export configuration, including export settings, delivery status, and recent export activity.
CapacityManagerDataExportId (string) --
The unique identifier for the data export configuration.
S3BucketName (string) --
The name of the S3 bucket where export files are delivered.
S3BucketPrefix (string) --
The S3 key prefix used for organizing export files within the bucket.
Schedule (string) --
The frequency at which data exports are generated.
OutputFormat (string) --
The file format of the exported data.
CreateTime (datetime) --
The timestamp when the data export configuration was created.
LatestDeliveryStatus (string) --
The status of the most recent export delivery.
LatestDeliveryStatusMessage (string) --
A message describing the status of the most recent export delivery, including any error details if the delivery failed.
LatestDeliveryS3LocationUri (string) --
The S3 URI of the most recently delivered export file.
LatestDeliveryTime (datetime) --
The timestamp when the most recent export was delivered to S3.
Tags (list) --
The tags associated with the data export configuration.
(dict) --
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.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Enables EC2 Capacity Manager for your account. This starts data ingestion for your EC2 capacity usage across On-Demand, Spot, and Capacity Reservations. Initial data processing may take several hours to complete.
See also: AWS API Documentation
Request Syntax
client.enable_capacity_manager(
OrganizationsAccess=True|False,
DryRun=True|False,
ClientToken='string'
)
boolean
Specifies whether to enable cross-account access for Amazon Web Services Organizations. When enabled, Capacity Manager can aggregate data from all accounts in your organization. Default is false.
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CapacityManagerStatus': 'enabled'|'disabled',
'OrganizationsAccess': True|False
}
Response Structure
(dict) --
CapacityManagerStatus (string) --
The current status of Capacity Manager after the enable operation.
OrganizationsAccess (boolean) --
Indicates whether Organizations access is enabled for cross-account data aggregation.
Creates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.
See also: AWS API Documentation
Request Syntax
client.create_capacity_manager_data_export(
S3BucketName='string',
S3BucketPrefix='string',
Schedule='hourly',
OutputFormat='csv'|'parquet',
ClientToken='string',
DryRun=True|False,
TagSpecifications=[
{
'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-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'|'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'|'capacity-manager-data-export',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
[REQUIRED]
The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.
string
The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.
string
[REQUIRED]
The frequency at which data exports are generated.
string
[REQUIRED]
The file format for the exported data. Parquet format is recommended for large datasets and better compression.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
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.
list
The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
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.
dict
Response Syntax
{
'CapacityManagerDataExportId': 'string'
}
Response Structure
(dict) --
CapacityManagerDataExportId (string) --
The unique identifier for the created data export configuration. Use this ID to reference the export in other API calls.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}}
{'HostReservationSet': {'State': {'cancelled',
'delayed',
'expired',
'failed',
'pending',
'scheduled',
'unsupported'}}}
Describes reservations that are associated with Dedicated Hosts in your account.
See also: AWS API Documentation
Request Syntax
client.describe_host_reservations(
Filter=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
HostReservationIdSet=[
'string',
],
MaxResults=123,
NextToken='string'
)
list
The filters.
instance-family - The instance family (for example, m4).
payment-option - The payment option ( NoUpfront | PartialUpfront | AllUpfront).
state - The state of the reservation ( payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
list
The host reservation IDs.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
string
The token to use to retrieve the next page of results.
dict
Response Syntax
{
'HostReservationSet': [
{
'Count': 123,
'CurrencyCode': 'USD',
'Duration': 123,
'End': datetime(2015, 1, 1),
'HostIdSet': [
'string',
],
'HostReservationId': 'string',
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'OfferingId': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'Start': datetime(2015, 1, 1),
'State': 'active'|'expired'|'cancelled'|'scheduled'|'pending'|'failed'|'delayed'|'unsupported'|'payment-pending'|'payment-failed'|'retired',
'UpfrontPrice': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
HostReservationSet (list) --
Details about the reservation's configuration.
(dict) --
Details about the Dedicated Host Reservation and associated Dedicated Hosts.
Count (integer) --
The number of Dedicated Hosts the reservation is associated with.
CurrencyCode (string) --
The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
Duration (integer) --
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
End (datetime) --
The date and time that the reservation ends.
HostIdSet (list) --
The IDs of the Dedicated Hosts associated with the reservation.
(string) --
HostReservationId (string) --
The ID of the reservation that specifies the associated Dedicated Hosts.
HourlyPrice (string) --
The hourly price of the reservation.
InstanceFamily (string) --
The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
OfferingId (string) --
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
PaymentOption (string) --
The payment option selected for this reservation.
Start (datetime) --
The date and time that the reservation started.
State (string) --
The state of the reservation.
UpfrontPrice (string) --
The upfront price of the reservation.
Tags (list) --
Any tags assigned to the Dedicated Host Reservation.
(dict) --
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.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'LaunchTemplateVersions': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}}
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}},
'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}}
{'Tags': {'ResourceType': {'capacity-manager-data-export'}}}
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_tags(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
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.
list
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'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-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'|'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'|'capacity-manager-data-export',
'Value': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}
{'PoolTagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range.
See also: AWS API Documentation
Request Syntax
client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
},
PubliclyAdvertisable=True|False,
Description='string',
DryRun=True|False,
PoolTagSpecifications=[
{
'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-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'|'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'|'capacity-manager-data-export',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiRegion=True|False,
NetworkBorderGroup='string'
)
string
[REQUIRED]
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
dict
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Message (string) -- [REQUIRED]
The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]
The signed authorization message for the prefix and account.
boolean
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
string
A description for the address range and the address pool.
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.
list
The tags to apply to the address pool.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
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.
boolean
Reserved.
string
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'AsnAssociations': [
{
'Asn': 'string',
'Cidr': 'string',
'StatusMessage': 'string',
'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
},
],
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
AsnAssociations (list) --
The BYOIP CIDR associations with ASNs.
(dict) --
An Autonomous System Number (ASN) and BYOIP CIDR association.
Asn (string) --
The association's ASN.
Cidr (string) --
The association's CIDR.
StatusMessage (string) --
The association's status message.
State (string) --
The association's state.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address range.
advertised: The address range is being advertised to the internet by Amazon Web Services.
deprovisioned: The address range is deprovisioned.
failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
failed-provision: The request to provision the address range was unsuccessful.
pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
pending-provision: You’ve submitted a request to provision an address range and it's pending.
provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
NetworkBorderGroup (string) --
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}},
'TagSpecifications': {'ResourceType': {'capacity-manager-data-export'}}}}