How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon EC2 Auto Scaling #Action=DescribeInstanceRefreshes API

The #Action=DescribeInstanceRefreshes API from Amazon EC2 Auto Scaling — 1 operation(s) for #action=describeinstancerefreshes.

Amazon EC2 Auto Scaling #Action=DescribeInstanceRefreshes API is one of 65 APIs that Amazon EC2 Auto Scaling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include #Action=DescribeInstanceRefreshes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a getting-started guide, pricing, an API reference, and 3 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 73 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 6 base URLs: http://autoscaling.{region}.amazonaws.com, https://autoscaling.{region}.amazonaws.com, http://autoscaling.amazonaws.com, https://autoscaling.amazonaws.com, http://autoscaling.{region}.amazonaws.com.cn, https://autoscaling.{region}.amazonaws.com.cn.

2 operations 1 paths 73 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://autoscaling.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon EC2 Auto Scaling #Action=DescribeInstanceRefreshes API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

#Action=DescribeInstanceRefreshes 2
GET
/#Action=DescribeInstanceRefreshes
Amazon EC2 Auto Scaling GET Describe Instance Refreshes
GET_DescribeInstanceRefreshes 13 params → 200480481
POST
/#Action=DescribeInstanceRefreshes
Amazon EC2 Auto Scaling POST Describe Instance Refreshes
POST_DescribeInstanceRefreshes 9 params body → 200480481

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are InstanceRequirements (23 properties), InstanceRefresh (12 properties), RefreshPreferences (8 properties), InstancesDistribution (6 properties). Each schema is shown below with its type and property counts.

VCpuCountRequest
object
Specifies the minimum and maximum for the VCpuCount object when you specify InstanceRequirements for an Auto Scaling group.
2 properties 1 required
NullablePositiveInteger
integer
ResourceContentionFault
NullableBoolean
boolean
BurstablePerformance
string
MixedInstanceSpotPrice
string
AcceleratorNames
array
StandbyInstances
string
CpuManufacturer
string
InstancesToUpdate
integer
MaxRecords
integer
CheckpointDelay
integer
RefreshPreferences
object
Describes the preferences for an instance refresh.
8 properties
AcceleratorManufacturer
string
TimestampType
string
IntPercent
integer
LaunchTemplateSpecification
object
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information abo…
3 properties
OnDemandBaseCapacity
integer
NullablePositiveDouble
number
InstanceGeneration
string
LocalStorageTypes
array
ScaleInProtectedInstances
string
DescribeInstanceRefreshesAnswer
object
2 properties
LaunchTemplate
object
Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.
2 properties
MixedInstancesPolicy
object
Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy co…
2 properties
XmlStringMaxLen1023
string
InstanceRequirements
object
The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then,…
23 properties 2 required
AllowedInstanceTypes
array
LaunchTemplateName
string
InstanceRefresh
object
Describes an instance refresh for an Auto Scaling group.
12 properties
AutoRollback
boolean
OnDemandPercentageAboveBaseCapacity
integer
TotalLocalStorageGBRequest
object
Specifies the minimum and maximum for the TotalLocalStorageGB object when you specify InstanceRequirements for an Auto Scaling group.
2 properties
CheckpointPercentages
array
DescribeInstanceRefreshesType
object
4 properties 1 required
InstanceRefreshIds
array
AcceleratorTotalMemoryMiBRequest
object
Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
2 properties
XmlString
string
RefreshInstanceWarmup
integer
NetworkInterfaceCountRequest
object
Specifies the minimum and maximum for the NetworkInterfaceCount object when you specify InstanceRequirements for an Auto Scaling group.
2 properties
InstanceGenerations
array
MemoryGiBPerVCpuRequest
object
Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you specify InstanceRequirements for an Auto Scaling group.
2 properties
RollbackDetails
object
Details about an instance refresh rollback.
5 properties
LocalStorageType
string
NetworkBandwidthGbpsRequest
object
Specifies the minimum and maximum for the NetworkBandwidthGbps object when you specify InstanceRequirements for an Auto Scaling group. Setting the minimum band…
2 properties
AcceleratorCountRequest
object
Specifies the minimum and maximum for the AcceleratorCount object when you specify InstanceRequirements for an Auto Scaling group.
2 properties
AcceleratorManufacturers
array
InvalidNextToken
LaunchTemplateOverrides
object
Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy: Override the instance type that is…
4 properties
DesiredConfiguration
object
Describes the desired configuration for an instance refresh. If you specify a desired configuration, you must specify either a LaunchTemplate or a MixedInstanc…
2 properties
InstanceRefreshes
array
AcceleratorType
string
BaselineEbsBandwidthMbpsRequest
object
Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object when you specify InstanceRequirements for an Auto Scaling group.
2 properties
BareMetal
string
InstanceRefreshLivePoolProgress
object
Reports progress on replacing instances that are in the Auto Scaling group.
2 properties
XmlStringMaxLen32
string
XmlStringMaxLen255
string
InstanceRefreshStatus
string
NonZeroIntPercent
integer
CpuManufacturers
array
InstanceRefreshWarmPoolProgress
object
Reports progress on replacing instances that are in the warm pool.
2 properties
AllowedInstanceType
string
AcceleratorName
string
LocalStorage
string
MemoryMiBRequest
object
Specifies the minimum and maximum for the MemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
2 properties 1 required
InstancesDistribution
object
Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capac…
6 properties
ExcludedInstanceTypes
array
InstanceRefreshProgressDetails
object
Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instan…
2 properties
SpotInstancePools
integer
ExcludedInstance
string
Overrides
array
AcceleratorTypes
array
SkipMatching
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-ec2-auto-scaling-action-describeinstancerefreshes-api-openapi.yml Raw ↑

Other APIs Amazon EC2 Auto Scaling publishes across the network.

Amazon EC2 Auto Scaling #Action=AttachInstances API
Amazon EC2 Auto Scaling #Action=AttachLoadBalancers API
Amazon EC2 Auto Scaling #Action=AttachLoadBalancerTargetGroups API
Amazon EC2 Auto Scaling #Action=AttachTrafficSources API
Amazon EC2 Auto Scaling #Action=BatchDeleteScheduledAction API
Amazon EC2 Auto Scaling #Action=BatchPutScheduledUpdateGroupAction API
Amazon EC2 Auto Scaling #Action=CancelInstanceRefresh API
Amazon EC2 Auto Scaling #Action=CompleteLifecycleAction API
Amazon EC2 Auto Scaling #Action=CreateAutoScalingGroup API
Amazon EC2 Auto Scaling #Action=CreateLaunchConfiguration API
Amazon EC2 Auto Scaling #Action=CreateOrUpdateTags API
Amazon EC2 Auto Scaling #Action=DeleteAutoScalingGroup API
Where this information came from

This is an independent, third-party profile of Amazon EC2 Auto Scaling #Action=DescribeInstanceRefreshes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.