Retrieve packages configuration
Retrieves the packages configuration, providing details about the available packages and their settings. Use this to review or verify package configurations for your environment.
HTTP method and endpoint
GET /aws/ha/metadata/packages
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
deploymentModel |
string |
query |
False |
|
capacityPackage |
string |
query |
False |
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
capacityTier |
string |
False |
|
description |
string |
False |
|
diskSize |
True |
||
diskType |
string |
False |
|
displayName |
string |
False |
|
instanceTenancy |
string |
False |
|
instanceTypeMapping |
array[InstanceTypeRegionMapping] |
True |
|
iops |
False |
||
licenseType |
string |
False |
|
name |
string |
True |
|
throughput |
False |
||
writingSpeedState |
string |
False |
Example error response
{
"capacityTier": "string",
"description": "string",
"diskSize": {
"unit": "string"
},
"diskType": "string",
"displayName": "string",
"instanceTenancy": "string",
"instanceTypeMapping": [
{
"instanceType": "string",
"region": "string"
}
],
"licenseType": "string",
"name": "string",
"writingSpeedState": "string"
}
Definitions
See Definitions
Capacity
| Name | Type | Required | Description |
|---|---|---|---|
size |
number |
False |
|
unit |
string |
False |
InstanceTypeRegionMapping
| Name | Type | Required | Description |
|---|---|---|---|
instanceType |
string |
False |
|
region |
string |
False |
iops
throughput