Questa documentazione è valida AWS CLI solo per la versione 1. Per la documentazione relativa alla versione 2 di AWS CLI, consulta la Guida per l'utente della versione 2.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Esempi di API Cloud Control che utilizzano AWS CLI
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando l'API AWS Command Line Interface with Cloud Control.
Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.
Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Azioni
Il seguente esempio di codice mostra come utilizzarecreate-resource.
- AWS CLI
-
Come creare una risorsa
L'
create-resourceesempio seguente crea una risorsa AWS: :Kinesis: :Stream, denominata ResourceExample, con un periodo di conservazione di 168 ore e un numero di frammenti pari a tre.aws cloudcontrol create-resource \ --type-nameAWS::Kinesis::Stream\ --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}"Output:
{ "ProgressEvent": { "EventTime": 1632506656.706, "TypeName": "AWS::Kinesis::Stream", "OperationStatus": "IN_PROGRESS", "Operation": "CREATE", "Identifier": "ResourceExample", "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5" } }Per ulteriori informazioni, consulta Creazione di una risorsa nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta CreateResource
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzaredelete-resource.
- AWS CLI
-
Come eliminare una risorsa
L'
delete-resourceesempio seguente elimina una risorsa AWS: :Kinesis: :Stream con l'identificatore ResourceExample dal tuo account. AWSaws cloudcontrol delete-resource \ --type-nameAWS::Kinesis::Stream\ --identifierResourceExampleOutput:
{ "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "ResourceExample", "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111", "Operation": "DELETE", "OperationStatus": "IN_PROGRESS", "EventTime": 1632950300.14 } }Per ulteriori informazioni, consulta Eliminazione di una risorsa nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta Command Reference. DeleteResource
AWS CLI
-
Il seguente esempio di codice mostra come utilizzareget-resource-request-status.
- AWS CLI
-
Come ottenere informazioni sullo stato di una richiesta di risorse
L’esempio
get-resource-request-statusseguente restituisce informazioni sullo stato della richiesta di risorse specificata.aws cloudcontrol get-resource-request-status \ --request-token"e1a6b86e-46bd-41ac-bfba-001234567890"Output:
{ "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "Demo", "RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890", "Operation": "CREATE", "OperationStatus": "FAILED", "EventTime": 1632950268.481, "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", "ErrorCode": "AlreadyExists" } }Per ulteriori informazioni, consulta Gestione delle richieste di operazioni sulle risorse nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta GetResourceRequestStatus AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-resource.
- AWS CLI
-
Come ottenere lo stato attuale di una risorsa
L'
get-resourceesempio seguente restituisce lo stato corrente della risorsa AWS: :Kinesis: :Stream denominata. ResourceExampleaws cloudcontrol get-resource \ --type-nameAWS::Kinesis::Stream\ --identifierResourceExampleOutput:
{ "TypeName": "AWS::Kinesis::Stream", "ResourceDescription": { "Identifier": "ResourceExample", "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}" } }Per ulteriori informazioni, consulta Lettura dello stato corrente di una risorsa nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta Command GetResource
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzarelist-resource-requests.
- AWS CLI
-
Come elencare le richieste di operazioni per le risorse attive
L'
list-resource-requestsesempio seguente elenca le richieste di risorse per le operazioni CREATE e UPDATE che non sono riuscite nell' AWS account.aws cloudcontrol list-resource-requests \ --resource-request-status-filterOperations=CREATE,OperationStatuses=FAILEDOutput:
{ "ResourceRequestStatusSummaries": [ { "TypeName": "AWS::Kinesis::Stream", "Identifier": "Demo", "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7", "Operation": "CREATE", "OperationStatus": "FAILED", "EventTime": 1632950268.481, "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", "ErrorCode": "AlreadyExists" } ] }Per ulteriori informazioni, consulta Gestione delle richieste di operazioni sulle risorse nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta ListResourceRequests AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-resources.
- AWS CLI
-
Come elencare le risorse di un determinato tipo
L'
list-resourcesesempio seguente elenca le risorse AWS: :Kinesis: :Stream fornite nel tuo account. AWSaws cloudcontrol list-resources \ --type-nameAWS::Kinesis::StreamOutput:
{ "TypeName": "AWS::Kinesis::Stream", "ResourceDescriptions": [ { "Identifier": "MyKinesisStream", "Properties": "{\"Name\":\"MyKinesisStream\"}" }, { "Identifier": "AnotherStream", "Properties": "{\"Name\":\"AnotherStream\"}" } ] }Per ulteriori informazioni, consulta Rilevamento delle risorse nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta ListResources
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareupdate-resource.
- AWS CLI
-
Come aggiornare le proprietà di una risorsa esistente
L'
update-resourceesempio seguente aggiorna la politica di conservazione di una LogGroup risorsa AWS: :Logs:: denominata ExampleLogGroup a 90 giorni.aws cloudcontrol update-resource \ --type-nameAWS::Logs::LogGroup\ --identifierExampleLogGroup\ --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]"Output:
{ "ProgressEvent": { "EventTime": "2021-08-09T18:17:15.219Z", "TypeName": "AWS::Logs::LogGroup", "OperationStatus": "IN_PROGRESS", "Operation": "UPDATE", "Identifier": "ExampleLogGroup", "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789" } }Per ulteriori informazioni, consulta Aggiornamento di una risorsa nella Guida per l’utente di Cloud Control API.
-
Per i dettagli sull'API, consulta AWS CLI Command UpdateResource
Reference.
-