The following tables list the API operations available for use in Resource Orchestration Service (ROS).
Stack operations
| API | Description |
|---|---|
| CancelUpdateStack | Cancels the update of a stack. |
| ContinueCreateStack | Creates a new stack based on the template of the previous stack that fails to be created. |
| CreateStack | Creates a stack. |
| GetStack | Queries information about stacks. |
| DeleteStack | Deletes a stack and all of its resources. |
| UpdateStack | Updates a stack. |
| ListStacks | Queries the list of stacks. |
| PreviewStack | Previews the stack to be created by using a specific template. |
| ListStackEvents | Queries stacks and their resource events. |
Resource operations
| API | Description |
|---|---|
| GetResourceTypeTemplate | Queries the template of a resource by resource type. |
| ListStackResources | Queries the resource list of a specific stack. |
| GetStackResource | Queries information about a resource in a specific stack. |
| GetResourceType | Queries detailed information about a resource type. |
| ListResourceTypes | Queries the list of supported resource types. |
Template operations
| API | Description |
|---|---|
| GetTemplateEstimateCost | Queries estimated prices of resources to be created based on a template. |
| ValidateTemplate | Validates the template that is used to create stacks. |
| GetTemplate | Queries detailed information about a template, including stacks and change sets associated with the template. |
| DeleteTemplate | Deletes a template. |
| ListTemplates | Queries the list of templates. |
| CreateTemplate | Creates a template. |
| UpdateTemplate | Updates a template. |
| GetTemplateSummary | Queries information about a new or existing template. |
| ListTemplateVersions | Queries one or more versions of a template. |
| SetTemplatePermission | Shares or unshares a template. |
| GenerateTemplatePolicy | Generates the policy information for a template. |
Stack policy operations
| API | Description |
|---|---|
| SetStackPolicy | Configures a stack policy. |
| GetStackPolicy | Queries information about a stack policy. |
Change set operations
| API | Description |
|---|---|
| CreateChangeSet | Creates a change set. |
| DeleteChangeSet | Deletes a change set. |
| ExecuteChangeSet | Executes a change set. |
| GetChangeSet | Queries information about a change set. |
| ListChangeSets | Queries the list of change sets. |
Stack group operations
| API | Description |
|---|---|
| CreateStackGroup | Creates a stack group. |
| DeleteStackGroup | Deletes a stack group. |
| GetStackGroup | Queries information about a stack group. |
| ListStackGroups | Queries the list of stack groups. |
| UpdateStackGroup | Updates a stack group. |
| CreateStackInstances | Creates stack instances in a specific account and region. |
| DeleteStackInstances | Deletes stack instances in a specific account and region. |
| GetStackInstance | Queries details about stack instances associated with a stack group. |
| ListStackInstances | Queries the list of stack instances associated with a stack group. |
| UpdateStackInstances | Updates stack instances in a specific account and region. |
| GetStackGroupOperation | Queries information about a stack group operation. |
| ListStackGroupOperations | Queries the list of stack group operations. |
| StopStackGroupOperation | Stops a stack group operation. |
| ListStackGroupOperationResults | Queries the result list of stack group operations. |
Drift detection operations
| API | Description |
|---|---|
| UpdateStackTemplateByResources | Corrects a template to eliminate stack drift. |
| DetectStackDrift | Detects drift on all supported resources for a stack. |
| DetectStackGroupDrift | Detects drift on a stack group. |
| DetectStackResourceDrift | Detects drift on individual resources in a stack. |
| GetStackDriftDetectionStatus | Queries the drift detection status of a stack. |
| ListStackResourceDrifts | Queries the drift information of resources in a specific stack. |
Tag operations
| API | Description |
|---|---|
| TagResources | Creates and binds tags to a specific ROS resource list. |
| UntagResources | Unbinds and deletes tags from a specific ROS resource list. |
| ListTagResources | Queries the tags that are bound to one or more ROS resources. |
| ListTagKeys | Queries tag keys. |
| ListTagValues | Queries the values of specific tag keys. |
Other operations
| API | Description |
|---|---|
| DescribeRegions | Queries available regions. |
| SignalResource | Sends signals. |
| SetDeletionProtection | Configures deletion protection for a stack. |
| ListStackOperationRisks | Detects the resources that may face high risks caused by a stack deletion operation, and queries the reason for each risk. |