[metadata]
abstract: Insert abstract text
assets_root: /assets
default_state: what-is-cloudcontrolapi
deployment_region: IAD
description: Describes Cloud Control API, a service that provides a standardized set of APIs for operating on resources across a wide range of AWS services.
feedback-item: CloudFormation
feedback-no: feedbackno.html?topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html
feedback-yes: feedbackyes.html?topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html
feedback: https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=CloudFormation&topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html
forums: https://repost.aws/tags/TArPmMO7eHRYympxY7eh_tXA
guide-locale: en_us
guide: User Guide
keywords: Cloud Control API,cloudapi
pdf: /pdfs/cloudcontrolapi/latest/userguide/cloudapi-service.pdf#what-is-cloudcontrolapi
product: Cloud Control API
rss: cloudapi-service.rss
target_state: what-is-cloudcontrolapi
this_doc_guide: User Guide
this_doc_product: Cloud Control API
tocs: toc-contents.json
viewport: width=device-width,initial-scale=1

[canonical-links]
https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html

[document-links]
/pdfs/cloudcontrolapi/latest/userguide/cloudapi-service.pdf#what-is-cloudcontrolapi
AWS Cloud Control API: /cloudcontrolapi/index.html
AWS CloudFormation User Guide: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html
CancelResourceRequest: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_CancelResourceRequest.html
CreateResource: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_CreateResource.html
DeleteResource: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_DeleteResource.html
Document Conventions: /general/latest/gr/docconventions.html
Documentation: /index.html
GetResource: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResource.html
GetResourceRequestStatus: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html
Getting started with Cloud Control API: ./getting-started.html
How Cloud Control API works: ./how-it-works.html
ListResourceRequests: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ListResourceRequests.html
ListResources: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ListResources.html
Setting up AWS Cloud Control API: ./setting-up.html
UpdateResource: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_UpdateResource.html
User Guide: what-is-cloudcontrolapi.html
View a markdown version of this page: what-is-cloudcontrolapi.md
cancel-resource-request: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/cancel-resource-request.html
create-resource: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/create-resource.html
delete-resource: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/delete-resource.html
get-resource-request-status: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/get-resource-request-status.html
get-resource: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/get-resource.html
list-resource-requests: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/list-resource-requests.html
list-resources: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/list-resources.html
update-resource: https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/update-resource.html

[structured-data]
{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://aws.amazon.com","name":"AWS","position":1},{"@type":"ListItem","item":"https://docs.aws.amazon.com/cloudcontrolapi/index.html","name":"AWS Cloud Control API","position":2},{"@type":"ListItem","item":"https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide","name":"User Guide","position":3},{"@type":"ListItem","item":"https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html","name":"What is AWS Cloud Control API?","position":4}]}

[content]
What is AWS Cloud Control API? - Cloud Control API
View a markdown version of this page
What is AWS Cloud Control API? - Cloud Control API
Documentation
AWS Cloud Control API
User Guide
Are you a first-time Cloud Control API user?
Features of Cloud Control API
Related services
Accessing Cloud Control API
What is AWS Cloud Control API?
Use AWS Cloud Control API to create, read, update, delete, and list (CRUD-L) your cloud resources that belong to AWS and third-party services. With the Cloud Control API standardized set of application programming interfaces (APIs), you can perform CRUD-L operations on any supported resources in your AWS account. Using Cloud Control API, you won't have to generate code or scripts specific to each individual service responsible for those resources.
Topics
Are you a first-time Cloud Control API user?
Features of Cloud Control API
Related services
Accessing Cloud Control API
How Cloud Control API works
Are you a first-time Cloud Control API user?
If you're a first-time user of Cloud Control API, we recommend that you begin by reading the following sections:
Setting up AWS Cloud Control API
Getting started with Cloud Control API
Features of Cloud Control API
Cloud Control API provides you with consistent control over the resources in your AWS account by offering a standardized way of accessing and provisioning those resources. It provides a uniform programmatic interface for making calls directly to the various resource types available in your AWS account, without having to be familiarized with the APIs of the underlying web services.
Related services
Similar to Cloud Control API, AWS CloudFormation also uses resource types to call underlying web services APIs to provision those resources when you place such a request in your account. However, CloudFormation focuses on providing resource management, by treating infrastructure as code. Using CloudFormation, you can author declarative templates that include multiple resources and their dependencies, and then provision those resources as a
stack
. A stack is a single unit that you then manage through CloudFormation. You can also centrally manage and provision stacks across multiple AWS accounts and AWS Regions. To be managed through CloudFormation, a resource must be created as part of a stack or imported into a stack. For more information, see the
AWS CloudFormation User Guide
.
Accessing Cloud Control API
Cloud Control API provides API operations for generating create, read, update, delete, and list (CRUD-L) resource requests in addition to tracking and managing those requests. You use the AWS Command Line Interface (AWS CLI) for Cloud Control API operations.
The following table shows the Cloud Control API operations you can use to generate CRUD-L resource requests.
API operation
AWS CLI command
CreateResource
create-resource
DeleteResource
delete-resource
GetResource
get-resource
ListResources
list-resources
UpdateResource
update-resource
The following table shows the Cloud Control API operations that you can use to track and manage resource requests while they're in process.
API operation
AWS CLI command
CancelResourceRequest
cancel-resource-request
GetResourceRequestStatus
get-resource-request-status
ListResourceRequests
list-resource-requests
Document Conventions
How it works
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
