<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Getting started with Cloud Control API - Cloud Control API</title><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="assets_root" content="/assets"><meta name="target_state" content="getting-started"><meta name="default_state" content="getting-started"><link rel="icon" type="image/ico" href="/assets/images/favicon.ico"><link rel="shortcut icon" type="image/ico" href="/assets/images/favicon.ico"><link rel="canonical" href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/getting-started.html"><meta name="description" content="Get started with Cloud Control API. Learn to perform CRUD-L operations on a resource."><meta name="deployment_region" content="IAD"><meta name="product" content="Cloud Control API"><meta name="guide" content="User Guide"><meta name="abstract" content="Insert abstract text"><meta name="guide-locale" content="en_us"><meta name="tocs" content="toc-contents.json"><link rel="canonical" href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/getting-started.html"><link rel="alternate" href="https://docs.aws.amazon.com/id_id/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="id-id"><link rel="alternate" href="https://docs.aws.amazon.com/id_id/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="id"><link rel="alternate" href="https://docs.aws.amazon.com/de_de/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="de-de"><link rel="alternate" href="https://docs.aws.amazon.com/de_de/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="de"><link rel="alternate" href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="en-us"><link rel="alternate" href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="en"><link rel="alternate" href="https://docs.aws.amazon.com/es_es/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="es-es"><link rel="alternate" href="https://docs.aws.amazon.com/es_es/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="es"><link rel="alternate" href="https://docs.aws.amazon.com/fr_fr/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="fr-fr"><link rel="alternate" href="https://docs.aws.amazon.com/fr_fr/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="fr"><link rel="alternate" href="https://docs.aws.amazon.com/it_it/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="it-it"><link rel="alternate" href="https://docs.aws.amazon.com/it_it/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="it"><link rel="alternate" href="https://docs.aws.amazon.com/ja_jp/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="ja-jp"><link rel="alternate" href="https://docs.aws.amazon.com/ja_jp/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="ja"><link rel="alternate" href="https://docs.aws.amazon.com/ko_kr/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="ko-kr"><link rel="alternate" href="https://docs.aws.amazon.com/ko_kr/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="ko"><link rel="alternate" href="https://docs.aws.amazon.com/pt_br/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="pt-br"><link rel="alternate" href="https://docs.aws.amazon.com/pt_br/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="pt"><link rel="alternate" href="https://docs.aws.amazon.com/zh_cn/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="zh-cn"><link rel="alternate" href="https://docs.aws.amazon.com/zh_tw/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="zh-tw"><link rel="alternate" href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/getting-started.html" hreflang="x-default"><meta name="feedback-item" content="CloudFormation"><meta name="this_doc_product" content="Cloud Control API"><meta name="this_doc_guide" content="User Guide"> <script defer="" src="/assets/r/awsdocs-doc-page.2.0.0.js"></script><link href="/assets/r/awsdocs-doc-page.2.0.0.css" rel="stylesheet"><script defer="" id="awsc-panorama-bundle" type="text/javascript" src="https://prod.pa.cdn.uis.awsstatic.com/panorama-nav-init.js" data-config="{'appEntity':'aws-documentation','region':'us-east-1','service':'cloudcontrolapi'}"></script><meta id="panorama-serviceSubSection" value="User Guide"><meta id="panorama-serviceConsolePage" value="Getting started with Cloud Control API"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/9436.80242c6b78ffcd66f0e0.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5393.f6d3da218f3c004eda1c.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/9181.d1165b10619351f4782d.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5720.64aebf60b561d3124e63.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5112.0080d42b0dd1f58b216c.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5955.4f073d3bea65c0f971ed.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5601.555e45574bdf2c2b326b.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/3486.a53c37b623013ebdef11.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/8763.e53c9a153e331f50be87.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/6208.da74153073836e32f9ac.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5999.422bee42a3bea0e09add.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/8903.6a8fb9db87ab5fa336da.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/3708.1abf383dfb7f28a7a55e.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/1622.8ec9b5e47054f595a76e.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5257.70aca8a45556d6cefdf4.css"><link rel="stylesheet" type="text/css" href="https://docs.aws.amazon.com/assets/r/5521.42b1fb4009ddb2afc2db.css"><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-i-open-c{display:inline-block;vertical-align:middle;line-height:1em;padding-left:.3em}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-i-open-c svg{stroke-width:2px;pointer-events:none;fill:none;padding-bottom:1px;height:10px;width:10px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-i-open-c svg .awsccc-stroke-linecap-square{stroke-linecap:square}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-i-open-c svg .awsccc-stroke-linejoin-round{stroke-linejoin:round}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-i-open-c svg path{stroke:currentColor}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-link{color:#0073bb}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-link span{color:#0073bb}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-link svg{height:16px;width:16px}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-link{color:#44b9d6}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-link span{color:#44b9d6}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn{flex:0 1 100%;padding:4px 20px;box-sizing:border-box;border:0;background-color:#fff;border:1px solid #545b64;color:#545b64;font-weight:700;border-radius:2px;cursor:pointer;user-select:none;display:inline-block;text-align:center;font-size:14px;position:relative}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn:hover{background-color:#fafafa}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn:focus{outline:none;text-decoration:none}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn:focus::before{content:" ";display:block;position:absolute;left:-2px;top:-2px;width:calc(100% + 4px);height:calc(100% + 4px);border-radius:2px;box-shadow:0 0 0 2px #00a1c9}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn span{line-height:22px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn.awsccc-u-btn-primary{background-color:#f90;border-color:#f90}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn.awsccc-u-btn-primary span{color:#0f141a}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn.awsccc-u-btn-primary:hover{background-color:#ec7211;border-color:#ec7211}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn.awsccc-u-btn-link{background-color:rgba(0,0,0,0);border-color:rgba(0,0,0,0);color:#545b64}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-btn.awsccc-u-btn-link:hover{color:#000;background-color:#fafafa}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-primary{background-color:#f90;border-color:#f90}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-primary span{color:#16191f}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-primary:hover{background-color:#ec7211;border-color:#ec7211}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-secondary{color:#d5dbdb;background-color:#2a2e30;border-color:#879596}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-secondary:hover{background-color:#21252c}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-link{color:#eaeded}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-btn-link:hover{color:#eaeded;background-color:#21252c}</style><style>#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c{position:fixed;bottom:0;left:0;width:100%;z-index:10000}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-content{position:relative;background:linear-gradient(180deg, rgba(21, 28, 39, 0.98) 0%, rgba(38, 51, 77, 0.98) 100%);box-shadow:0px -2px 5px 0px rgba(0,0,0,.5);padding:30px 30px 15px;border-top:solid 1px #306da3;display:flex;flex-direction:column}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-text-section{display:flex;flex-direction:column;flex-shrink:1;padding:0px}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-title{font-weight:700;padding:0 0 5px;margin:0;color:#fff}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-buttons{display:flex;justify-content:center;flex-wrap:wrap}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-buttons .awsccc-u-btn{margin-bottom:15px;padding-left:20px;padding-right:20px}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-text{flex:1 1 100%;margin:0 0 15px;color:#eaeded}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-text span{color:#eaeded}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c.awsc-bot-above-f-imp{z-index:1005}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c.dark-mode-enabled #awsccc-cb-content{background:none;background-color:#2a2e33}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c.dark-mode-enabled .awsccc-u-btn-secondary{background-color:#2a2e33}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c.dark-mode-enabled .awsccc-u-btn-secondary span{color:#d5dbdb}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c.dark-mode-enabled .awsccc-u-btn-secondary:hover{background-color:#21252c}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c.dark-mode-enabled .awsccc-u-btn-primary span{color:#16191f}@media screen and (min-width: 810px){#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-content{padding-bottom:30px;padding-left:20px;padding-right:20px;display:flex;justify-content:space-between}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-buttons .awsccc-u-btn{flex:1 0 25%;margin:10px 5px 0;min-width:240px}}@media screen and (min-width: 1020px){#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-content{flex-direction:row;padding-left:40px;padding-right:40px}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-actions{display:flex;justify-content:center;align-items:center}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-text{flex:1;padding-right:40px}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-buttons .awsccc-u-btn{flex:0 1 auto;margin:10px 5px 0}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-buttons{flex-wrap:nowrap;display:flex;flex-direction:column;gap:10px;width:max-content}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cb-c #awsccc-cb-buttons .awsccc-u-btn{margin-top:0}}@media screen and (min-width: 1020px){#awsccc-sb-ux-c #awsccc-sb-a.awsccc-Rtl #awsccc-cb-text{padding-left:40px;padding-right:0}}div[data-id=awsccc-cb]{display:none}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cl{display:flex;flex-direction:column}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cl-c{padding:10px;border-block-end:1px solid #eaeded}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cl-c:first-of-type{padding-top:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cl-c:last-of-type{padding-bottom:0;border-block-end:none}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-cl-c{border-color:#414750}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-container{display:flex;align-items:center;justify-content:center;bottom:0;left:0;right:0;top:0;position:fixed;outline:0;overflow:hidden;z-index:10002}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-backdrop{background-color:rgba(242,243,243,.9019607843);position:fixed;z-index:10001;right:0;top:0;bottom:0;left:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal{box-sizing:border-box;outline:none;margin:10px;background-color:#fff;border-radius:0;box-sizing:border-box;z-index:10002;position:relative;box-shadow:0 1px 1px 0 rgba(0,28,36,.3),1px 1px 1px 0 rgba(0,28,36,.15),-1px 1px 1px 0 rgba(0,28,36,.15)}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal[dir=rtl] *{direction:rtl;text-align:right}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal.awsccc-u-modal-large{max-width:820px;width:calc(100vw - 20px)}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-header{background-color:#fafafa;border-bottom:1px solid #eaeded;color:#16191f;padding:19px 20px;word-break:break-word;flex:auto}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-header h2{font-size:18px;font-weight:700;margin:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-content{overflow-y:auto;max-height:calc(100vh - 200px);padding:19px 20px}@media screen and (max-width: 480px){#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-content{max-height:calc(100vh - 275px)}}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-footer{border-top:1px solid #eaeded;text-decoration:none;padding:10px 20px;text-align:right;display:flex;justify-content:flex-end;flex-wrap:wrap}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-footer button{white-space:nowrap}@media screen and (max-width: 699px){#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-footer button{white-space:initial}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-footer>div{width:100%}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-modal-footer .awsccc-u-sb{display:flex;flex-direction:column}}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-modal-backdrop{background-color:rgba(22,25,31,.8)}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-modal{background-color:#2a2e33}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-modal-header{background-color:#21252c;border-bottom-color:#414750;color:#eaeded}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-modal-content{color:#eaeded}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-modal-footer{border-top-color:#414750}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-sb{display:flex;flex-direction:row}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-sb.awsccc-u-sb-v{flex-direction:column}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-sb.awsccc-u-sb-xxs{gap:4px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-sb.awsccc-u-sb-xs{gap:8px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-sb.awsccc-u-sb-s{gap:12px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-sb.awsccc-u-sb-m{gap:16px}</style><style>#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-info-container span,#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-info-container a{font-size:15px}</style><style>#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-l-container span,#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-l-container a{font-size:12px;line-height:15px}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-l-container span:focus,#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-l-container a:focus{outline-style:solid;outline-color:#00a1c9;outline-width:2px}#awsccc-sb-ux-c #awsccc-sb-a #awsccc-cs-l-container p>span{color:#687078}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled #awsccc-cs-l-container span{color:#eaeded}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled #awsccc-cs-l-container span a{display:inline-block}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled #awsccc-cs-l-container span a span{color:#44b9d6}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled #awsccc-cs-l-container path{color:#44b9d6}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-s-cb-hidden{text-indent:-9999px;position:absolute}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-label{position:relative;display:inline-block;line-height:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-text{line-height:16px;vertical-align:top;overflow-wrap:break-word}#awsccc-sb-ux-c #awsccc-sb-a .awscc-u-cb-checkbox,#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-input{height:14px;width:14px;z-index:1;pointer-events:none;fill:none}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-s-cb-outer{margin-right:8px;height:14px;width:14px;display:inline-block}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-input{padding:0;margin:0;position:absolute;z-index:0;opacity:0}#awsccc-sb-ux-c #awsccc-sb-a .awscc-u-cb-checkbox-rect{background-color:#fff;fill:#fff;stroke:#687078;stroke-width:1}#awsccc-sb-ux-c #awsccc-sb-a .awscc-u-cb-checkbox-poly-line{opacity:1;stroke:#fff;stroke-width:2;fill:none}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-checkbox-active .awscc-u-cb-checkbox-rect{fill:#0073bb;stroke:#0073bb}#awsccc-sb-ux-c #awsccc-sb-a .awscc-u-cb-checkbox-container{position:relative;line-height:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-focused:before{content:" ";display:block;position:absolute;left:-2px;top:-2px;width:calc(100% + 4px);height:calc(100% + 4px);border-radius:2px;box-shadow:0 0 0 2px #00a1c9}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-gpc-disabled .awscc-u-cb-checkbox{opacity:.5}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-cb-gpc-disabled .awscc-u-cb-checkbox .awscc-u-cb-checkbox-rect{fill:#f2f3f3;stroke:#d5dbdb}#awsccc-sb-ux-c #awsccc-sb-a.awsccc-Rtl .awsccc-cs-s-cb-outer{margin-left:8px;margin-right:0}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container{position:relative;overflow-wrap:break-word;word-wrap:break-word}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-title{font-size:18px;line-height:20px;flex:0 0 100%;margin:0 0 5px;z-index:10;display:inline-block;line-height:normal;font-weight:400}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-text{flex:0 0 80%;padding-top:5px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-action{display:flex;justify-content:flex-end;flex:1;position:relative;margin-top:8px;margin-bottom:8px}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-paragraph{margin-top:0;font-size:14px;line-height:20px;padding:0;margin-bottom:15px}@media screen and (min-width: 700px){#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container{display:flex;flex-wrap:wrap}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-title{padding-bottom:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-text{border-top:0}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cs-sec-container .awsccc-cs-s-action{justify-content:center;position:relative;top:auto;right:auto;padding-top:20px}}</style><style>#awsccc-sb-ux-c #awsccc-sb-a{font-family:"Amazon Ember","HelveticaNeue","Helvetica Neue","Amazon Ember",Roboto,"Roboto-Regular","Amazon Ember",Helvetica,Arial,sans-serif;font-size:14px;line-height:21px;color:#16191f;text-align:left}#awsccc-sb-ux-c #awsccc-sb-a *{background:none;border:0}#awsccc-sb-ux-c #awsccc-sb-a.awsccc-Rtl *{direction:rtl;text-align:right}@media screen and (min-width: 1020px){#awsccc-sb-ux-c #awsccc-sb-a.awsccc-Rtl #awsccc-cb-c #awsccc-cb-title{padding-right:40px}}#awsccc-sb-ux-c #awsccc-sb-a a,#awsccc-sb-ux-c #awsccc-sb-a a>span,#awsccc-sb-ux-c #awsccc-sb-a a svg path{color:#0073bb;text-decoration:underline;font-weight:700}#awsccc-sb-ux-c #awsccc-sb-a a:hover,#awsccc-sb-ux-c #awsccc-sb-a a>span:hover,#awsccc-sb-ux-c #awsccc-sb-a a svg path:hover{color:#0073bb;text-decoration:underline}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled{color-scheme:dark}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled a,#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled a>span,#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled a svg path{color:#44b9d6;text-decoration:underline;font-weight:700}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled a:hover,#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled a>span:hover,#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled a svg path:hover{color:#44b9d6}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-tab-helper{outline:0;text-decoration:none}body.awsccc-modal-open{overflow:hidden;-webkit-box-sizing:border-box;box-sizing:border-box}.awsccc-gpc-warning{background-color:#fef7e6;border:1px solid #f0c744;border-radius:4px;padding:12px 16px;margin:8px 0}.awsccc-gpc-warning strong{display:block;margin-bottom:4px;color:#8d6605}.awsccc-gpc-warning p{margin:0;color:#5f4204;font-size:14px;line-height:1.5}.dark-mode-enabled .awsccc-gpc-warning{background-color:#3d2f00;border-color:#7d6200}.dark-mode-enabled .awsccc-gpc-warning strong{color:#f9dc5c}.dark-mode-enabled .awsccc-gpc-warning p{color:#e8d08a}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-field{display:flex;flex-direction:column;gap:4px}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg>label{position:relative}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg input[type=radio]{opacity:0;user-select:none;cursor:default;position:absolute}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg .awsccc-u-rg-radio{display:inline-block;box-sizing:content-box;position:relative;vertical-align:middle;height:14px;width:14px;border-radius:50%;background-color:#fff;border:2px solid #7d8998;transition:background-color ease .15s,border-color ease .15s}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg .awsccc-u-rg-radio::before{position:absolute;content:"";height:6px;width:6px;border-radius:50%;top:4px;left:4px;transition:background-color ease .15s}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg .awsccc-u-rg-radio+span{padding-inline-start:8px;vertical-align:middle}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg input:checked+.awsccc-u-rg-radio{background-color:#0073bb;border-color:#0073bb}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg input:checked+.awsccc-u-rg-radio::before{background-color:#fff}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-u-rg input:focus-visible+.awsccc-u-rg-radio{outline:2px solid #00a1c9;outline-offset:2px}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled .awsccc-u-rg-radio{background-color:#1a2029;border-color:#879596}#awsccc-sb-ux-c #awsccc-sb-a .dark-mode-enabled input:checked+.awsccc-u-rg-radio{background-color:#00a1c9;border-color:#00a1c9}</style><style>#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cbbas-c{overflow-wrap:break-word;word-wrap:break-word}#awsccc-sb-ux-c #awsccc-sb-a .awsccc-cbbas-c p{margin:0;overflow-wrap:break-word}.awsccc-gpc-warning{background-color:#fef7e6;border-left:4px solid #f89406;padding:12px;margin-bottom:16px}.awsccc-gpc-warning strong{display:block;margin-bottom:8px;color:#333}.awsccc-gpc-warning p{margin:0;color:#666;font-size:14px;line-height:1.5}.dark-mode-enabled .awsccc-gpc-warning{background-color:#3d2f00;border-color:#7d6200}.dark-mode-enabled .awsccc-gpc-warning strong{color:#f9dc5c}.dark-mode-enabled .awsccc-gpc-warning p{color:#e8d08a}</style><script charset="utf-8" data-webpack="@amzn/aws-docs-website-assets-react:chunk-7292" src="https://docs.aws.amazon.com/assets/r/7292.394d51fb792fe4a26326.js"></script></head>
<body class="awsdocs awsui awsui-visual-refresh"><div class="awsdocs-container"><p><a href="getting-started.md">View a markdown version of this page</a></p><awsdocs-header></awsdocs-header><awsui-app-layout id="app-layout" class="awsui-util-no-gutters" ng-controller="ContentController as $ctrl" header-selector="awsdocs-header" navigation-hide="false" navigation-width="$ctrl.navWidth" navigation-open="$ctrl.navOpen" navigation-change="$ctrl.onNavChange($event)" tools-hide="$ctrl.hideTools" tools-width="$ctrl.toolsWidth" tools-open="$ctrl.toolsOpen" tools-change="$ctrl.onToolsChange($event)"><div id="guide-toc" dom-region="navigation"><awsdocs-toc></awsdocs-toc></div><div id="main-column" dom-region="content" tabindex="-1"><awsdocs-view class="awsdocs-view"><div id="awsdocs-content"><title>Getting started with Cloud Control API - Cloud Control API</title><meta name="pdf" content="/pdfs/cloudcontrolapi/latest/userguide/cloudapi-service.pdf#getting-started"><meta name="rss" content="cloudapi-service.rss"><meta name="forums" content="https://repost.aws/tags/TArPmMO7eHRYympxY7eh_tXA"><meta name="feedback" content="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=CloudFormation&amp;topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/getting-started.html"><meta name="feedback-yes" content="feedbackyes.html?topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/getting-started.html"><meta name="feedback-no" content="feedbackno.html?topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/getting-started.html"><meta name="keywords" content="Cloud Control API,cloudapi"><link rel="alternate" type="text/markdown" href="getting-started.md" title="Markdown version"><script type="application/ld+json">
{
    "@context" : "https://schema.org",
    "@type" : "BreadcrumbList",
    "itemListElement" : [
      {
        "@type" : "ListItem",
        "position" : 1,
        "name" : "AWS",
        "item" : "https://aws.amazon.com"
      },
      {
        "@type" : "ListItem",
        "position" : 2,
        "name" : "AWS Cloud Control API",
        "item" : "https://docs.aws.amazon.com/cloudcontrolapi/index.html"
      },
      {
        "@type" : "ListItem",
        "position" : 3,
        "name" : "User Guide",
        "item" : "https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide"
      },
      {
        "@type" : "ListItem",
        "position" : 4,
        "name" : "Getting started with Cloud Control API",
        "item" : "https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/getting-started.html"
      }
    ]
}
</script><div id="main"><div style="display: none"><a href="/pdfs/cloudcontrolapi/latest/userguide/cloudapi-service.pdf#getting-started" target="_blank" rel="noopener noreferrer" title="Open PDF"></a></div><div id="breadcrumbs" class="breadcrumb"><a href="/index.html">Documentation</a><a href="/cloudcontrolapi/index.html">AWS Cloud Control API</a><a href="what-is-cloudcontrolapi.html">User Guide</a></div><div id="page-toc-src"><a href="#getting-started-step1">Create a resource</a><a href="#getting-started-step2">Read a resource</a><a href="#getting-started-step3">Update a resource</a><a href="#getting-started-list">List resources</a><a href="#getting-started-cleanup">Delete a resource</a><a href="#getting-started-next-steps">Next steps</a></div><div id="main-content" class="awsui-util-container"><div id="main-col-body"><awsdocs-language-banner data-service="$ctrl.pageService"></awsdocs-language-banner><h1 class="topictitle" id="getting-started">Getting started with Cloud Control API</h1><div class="awsdocs-page-header-container"><awsdocs-page-header></awsdocs-page-header><awsdocs-filter-selector id="awsdocs-filter-selector"></awsdocs-filter-selector></div><p>Use this short tutorial to get started performing resource operations with AWS Cloud Control API.
        You'll learn the basics of using Cloud Control API to create, read, update, delete, and list
        resources.</p><div class="highlights" id="inline-topiclist"><h6>Topics</h6><ul><li><p><a href="#getting-started-step1">Step 1: Create a resource</a></p></li><li><p><a href="#getting-started-step2">Step 2: Read (describe) a resource</a></p></li><li><p><a href="#getting-started-step3">Step 3: Update a resource</a></p></li><li><p><a href="#getting-started-list">Step 4: List all resources of a certain type</a></p></li><li><p><a href="#getting-started-cleanup">Step 5: Delete a resource</a></p></li><li><p><a href="#getting-started-next-steps">Next steps</a></p></li></ul></div>
        <h2 id="getting-started-step1">Step 1: Create a resource</h2>
        <p>For this tutorial, create a resource of type <code class="code"><a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html"><code class="code">AWS::Logs::LogGroup</code></a></code>. Name this log group <code class="userinput">CloudControlExample</code>,
   and set the retention policy on it to 90 days.</p>
        <div class="procedure"><ol><li>
                <p>In the AWS Command Line Interface (AWS CLI), run the <code class="code">create-resource</code> command with
                    the following parameters:</p>
                <div class="itemizedlist">
                     
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">type-name</code> as
                            <code class="code">AWS::Logs::LogGroup</code>.</p>
                    </li><li class="listitem">
                        <p>Specify the <code class="code">desired-state</code> as a string containing JSON
                            that sets the desired properties:</p>
                        <p><code class="code"><span>{</span>"LogGroupName": "CloudControlExample", "RetentionInDays":
                                90}</code></p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol create-resource --type-name AWS::Logs::LogGroup \
    --desired-state '<span>{</span>"LogGroupName": "CloudControlExample","RetentionInDays":90}'</code></code></pre>
                <p>Cloud Control API returns a <code class="code">ProgressEvent</code> object that contains information
                    about the status of your resource operation request.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "ProgressEvent": <span>{</span>
        "EventTime": "2024-08-26T22:07:23.347Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "CREATE",
        "Identifier": "CloudControlExample",
        "RequestToken": "758f4a4e-fef4-491a-9b07-123456789012"
    }
}</code></pre>
            </li><li>
                <p>To track the status of your resource operation request, run the
                        <code class="code">get-resource-request-status</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">request-token</code> parameter as the
                                <code class="code">RequestToken</code> property value returned in the
                                <code class="code">ProgressEvent</code> object.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol get-resource-request-status --request-token <code class="replaceable">758f4a4e-fef4-491a-9b07-123456789012</code></code></code></pre>
                <p>Cloud Control API returns a <code class="code">ProgressEvent</code> object that contains information
                    about the status of your resource operation request. When Cloud Control API has
                    successfully created the resource, it sets the <code class="code">OperationStatus</code>
                    value to <code class="code">SUCCESS</code>.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "ProgressEvent": <span>{</span>
        "EventTime": "2024-08-26T22:29:23.326Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "SUCCESS",
        "Operation": "CREATE",
        "Identifier": "CloudControlExample",
        "RequestToken": "758f4a4e-fef4-491a-9b07-123456789012"
    }
}</code></pre>
            </li></ol></div>
     
        <h2 id="getting-started-step2">Step 2: Read (describe) a resource</h2>
        <p>Next, read the current state of the resource you just created.</p>
        <div class="procedure"><ul><li>
                <p>In the AWS CLI, run the <code class="code">get-resource</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify <code class="code">identifier</code> as the <code class="code">identifier</code>
                            property value returned in the <code class="code">ProgressEvent</code> object when
                            you created the resource. In this case, it's
                                <code class="code">CloudControlExample</code>, the name you specified for the log
                            group.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol get-resource --type-name AWS::Logs::LogGroup --identifier CloudControlExample</code></code></pre>
                <p>Cloud Control API returns detailed information about the resource's current state,
                    including a model of its properties and settings. In this case, this includes a
                    property, <code class="code">Arn</code>, that was generated by Amazon CloudWatch Events when the resource
                    was created.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "TypeName": "AWS::Logs::LogGroup", 
    "ResourceDescription": <span>{</span>
        "Identifier": "CloudControlExample", 
        "ResourceModel": '<span>{</span>"RetentionInDays": 90, "LogGroupName": "CloudControlExample", "Arn": "arn:aws:logs:us-west-2:123456789012:log-group:CloudControlExample:*"}'
    }
}</code></pre>
            </li></ul></div>
     
        <h2 id="getting-started-step3">Step 3: Update a resource</h2>
        <p>Next, update your log group to double the retention policy to 180 days.</p>
        <div class="procedure"><ol><li>
                <p>In the AWS CLI, run the <code class="code">update-resource</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                     
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">type-name</code> as
                            <code class="code">AWS::Logs::LogGroup</code>.</p>
                    </li><li class="listitem">
                        <p>Specify <code class="code">identifier</code> as the <code class="code">identifier</code>
                            property value returned in the <code class="code">ProgressEvent</code> object when
                            you created the resource. In this case, it's
                                <code class="code">CloudControlExample</code>, the name you specified for the log
                            group.</p>
                    </li><li class="listitem">
                        <p>Specify the <code class="code">patch-document</code> parameter as a string
                            containing JSON that represents a replacement operation that updates the
                            retention policy to 180 days.</p>
                        <p><code class="code">[<span>{</span>"op": "replace", "path": "RetentionInDays", "value":
                                180}]</code></p>
                        <p>For detailed information about composing patch documents, see <a href="./resource-operations-update.html#resource-operations-update-patch">Composing the patch document</a>.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol update-resource --type-name AWS::Logs::LogGroup \
    --identifier CloudControlExample \
    --patch-document '[<span>{</span>"op": "replace", "path": "RetentionInDays", "value":180}]'</code></code></pre>
                <p>Cloud Control API returns a <code class="code">ProgressEvent</code> object that contains information
                    about the status of your resource operation request.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "ProgressEvent": <span>{</span>
        "EventTime": "2024-08-26T22:29:22.547Z", 
        "ResourceModel": '<span>{</span>"RetentionInDays":180,"LogGroupName":"CloudControlExample"}',
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "UPDATE",
        "Identifier": "CloudControlExample", 
        "RequestToken": "2026055d-f21c-4b50-bd40-123456789012"
    }
}</code></pre>
            </li><li>
                <p>To track the status of your resource operation request, run the
                        <code class="code">get-resource-request-status</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">request-token</code> parameter as the
                                <code class="code">RequestToken</code> property value returned in the
                                <code class="code">ProgressEvent</code> object.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol get-resource-request-status --request-token <code class="replaceable">2026055d-f21c-4b50-bd40-123456789012</code></code></code></pre>
                <p>Cloud Control API returns a <code class="code">ProgressEvent</code> object that contains information
                    about the status of your resource operation request. When Cloud Control API has
                    successfully updated the resource, it sets the <code class="code">OperationStatus</code>
                    value to <code class="code">SUCCESS</code>.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "ProgressEvent": <span>{</span>
        "EventTime": "2024-08-26T22:29:23.326Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "SUCCESS",
        "Operation": "UPDATE",
        "Identifier": "CloudControlExample",
        "RequestToken": "2026055d-f21c-4b50-bd40-123456789012"
    }
}</code></pre>
            </li></ol></div>
     
        <h2 id="getting-started-list">Step 4: List all resources of a certain type</h2>
        <p>Next, use Cloud Control API to discover resources in your AWS account.</p>
        <div class="procedure"><ul><li>
                <p>In the AWS CLI, run the <code class="code">list-resources</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">type-name</code> as
                            <code class="code">AWS::Logs::LogGroup</code>.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol list-resources --type-name AWS::Logs::LogGroup</code></code></pre>
                <p>Cloud Control API returns a list of the <code class="code">AWS::Logs::LogGroup</code> resources in
                    your account, by primary identifier. This includes
                        <code class="code">CloudControlExample</code>, the resource you created as part of this
                    tutorial, in addition to any other log groups that already exist in your
                    account. Also, for <code class="code">AWS::Logs::LogGroup</code> resources, the information
                    returned by <code class="code">list-resources</code> includes the properties for each
                    resource.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "TypeName": "AWS::Logs::LogGroup",
    "ResourceDescriptions": [
        <span>{</span>
            "Identifier": "CloudControlExample",
            "Properties": '<span>{</span>"RetentionInDays":180, "LogGroupName": "CloudControlExample", "Arn":"arn:aws:logs:us-west-2:123456789012:log-group:CloudControlExample:*"}'
        },
        <span>{</span>
            "Identifier": "AnotherLogGroupResourceExample",
            "Properties": '<span>{</span>"RetentionInDays": 90, "LogGroupName": "AnotherLogGroupResourceExample", "Arn": "arn:aws:logs:us-west-2:123456789012:log-group:AnotherLogGroupResourceExample:*"}'
        },
    ]
}</code></pre>
            </li></ul></div>
     
        <h2 id="getting-started-cleanup">Step 5: Delete a resource</h2>
        <p>Finally, delete your log group to clean up from this tutorial.</p>
        <div class="procedure"><ol><li>
                <p>In the AWS CLI, run the <code class="code">delete-resource</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">type-name</code> as
                            <code class="code">AWS::Logs::LogGroup</code>.</p>
                    </li><li class="listitem">
                        <p>Specify <code class="code">identifier</code> as the <code class="code">identifier</code>
                            property value returned in the <code class="code">ProgressEvent</code> object when
                            you created the resource. In this case, it's
                                    <code class="userinput"><code class="code">CloudControlExample</code></code>, the
                            name you specified for the log group.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol delete-resource --type-name AWS::Logs::LogGroup --identifier CloudControlExample</code></code></pre>
                <p>Cloud Control API returns a <code class="code">ProgressEvent</code> object that contains information
                    about the status of your resource operation request.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "ProgressEvent": <span>{</span>
        "EventTime": "2024-08-26T22:50:20.037Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "DELETE",
        "Identifier": "CloudControlExample",
        "RequestToken": "bb0ed9cd-84f9-44c2-b638-123456789012"
    }
}</code></pre>
            </li><li>
                <p>To track the status of your resource operation request, run the
                        <code class="code">get-resource-request-status</code> command with the following
                    parameter:</p>
                <div class="itemizedlist">
                     
                <ul class="itemizedlist"><li class="listitem">
                        <p>Specify the <code class="code">request-token</code> parameter as the
                                <code class="code">RequestToken</code> property value returned in the
                                <code class="code">ProgressEvent</code> object.</p>
                    </li></ul></div>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (bash)--><code class="bash "><code class="prompt" copy="false">$ </code><code class="userinput">aws cloudcontrol get-resource-request-status --request-token <code class="replaceable">bb0ed9cd-84f9-44c2-b638-123456789012</code></code></code></pre>
                <p>Cloud Control API returns a <code class="code">ProgressEvent</code> object that contains information
                    about the status of your resource operation request. When Cloud Control API has
                    successfully deleted the resource, it sets the <code class="code">OperationStatus</code>
                    value to <code class="code">SUCCESS</code>.</p>
                <pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><!--DEBUG: cli (json)--><code class="json "><span>{</span>
    "ProgressEvent": <span>{</span>
        "EventTime": "2024-08-26T22:50:20.831Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "SUCCESS",
        "Operation": "DELETE",
        "Identifier": "CloudControlExample",
        "RequestToken": "bb0ed9cd-84f9-44c2-b638-123456789012"
    }
}</code></pre>
            </li></ol></div>
     
        <h2 id="getting-started-next-steps">Next steps</h2>
        <p>For detailed information and examples on using Cloud Control API with resources, see <a href="./resource-operations.html">Cloud Control API resource operations</a>.</p>
    <awsdocs-copyright class="copyright-print"></awsdocs-copyright><awsdocs-thumb-feedback right-edge="{{$ctrl.thumbFeedbackRightEdge}}"></awsdocs-thumb-feedback></div><noscript><div><div><div><div id="js_error_message"><p><img src="https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png" alt="Warning" /> <strong>Javascript is disabled or is unavailable in your browser.</strong></p><p>To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.</p></div></div></div></div></noscript><div id="main-col-footer" class="awsui-util-font-size-0"><div id="doc-conventions"><a target="_top" href="/general/latest/gr/docconventions.html">Document Conventions</a></div><div class="prev-next"><div id="previous" class="prev-link" accesskey="p" href="./setting-up.html">Setting up</div><div id="next" class="next-link" accesskey="n" href="./resource-operations.html">Cloud Control API resource operations</div></div></div><awsdocs-page-utilities></awsdocs-page-utilities></div><div id="quick-feedback-yes" style="display: none;"><div class="title">Did this page help you? - Yes</div><div class="content"><p>Thanks for letting us know we're doing a good job!</p><p>If you've got a moment, please tell us what we did right so we can do more of it.</p><p><awsui-button id="fblink" rel="noopener noreferrer" target="_blank" text="Feedback" click="linkClick($event)" href="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=CloudFormation&amp;topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/getting-started.html"></awsui-button></p></div></div><div id="quick-feedback-no" style="display: none;"><div class="title">Did this page help you? - No</div><div class="content"><p>Thanks for letting us know this page needs work. We're sorry we let you down.</p><p>If you've got a moment, please tell us how we can make the documentation better.</p><p><awsui-button id="fblink" rel="noopener noreferrer" target="_blank" text="Feedback" click="linkClick($event)" href="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=CloudFormation&amp;topic_url=https://docs.aws.amazon.com/en_us/cloudcontrolapi/latest/userguide/getting-started.html"></awsui-button></p></div></div></div></div></awsdocs-view><div class="page-loading-indicator" id="page-loading-indicator"><awsui-spinner size="large"></awsui-spinner></div></div><div id="tools-panel" dom-region="tools"><awsdocs-tools-panel id="awsdocs-tools-panel"></awsdocs-tools-panel></div></awsui-app-layout><awsdocs-cookie-banner class="doc-cookie-banner"></awsdocs-cookie-banner></div></body></html>