En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Soporte.
Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
Temas
Acciones
En el siguiente ejemplo de código, se muestra cómo utilizar add-attachments-to-set
.
- AWS CLI
-
Para añadir un archivo adjunto a un conjunto
En el siguiente ejemplo de
add-attachments-to-set
, se agrega una imagen a un conjunto que, a continuación, puede especificar para un caso de soporte en su cuenta de AWS.aws support add-attachments-to-set \ --attachment-set-id
"as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE"
\ --attachmentsfileName=troubleshoot-screenshot.png,data=base64-encoded-string
Salida:
{ "attachmentSetId": "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE", "expiryTime": "2020-05-14T17:04:40.790+0000" }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener detalles sobre la API, consulte AddAttachmentsToSet
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar add-communication-to-case
.
- AWS CLI
-
Para agregar una comunicación a un caso
En el siguiente ejemplo de
add-communication-to-case
, se agregan comunicaciones a un caso de soporte en su cuenta de AWS.aws support add-communication-to-case \ --case-id
"case-12345678910-2013-c4c1d2bf33c5cf47"
\ --communication-body"I'm attaching a set of images to this case."
\ --cc-email-addresses"myemail@example.com"
\ --attachment-set-id"as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE"
Salida:
{ "result": true }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte AddCommunicationToCase
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-case
.
- AWS CLI
-
Creación de un caso
En el siguiente ejemplo de
create-case
se crea un caso de soporte para su cuenta de AWS.aws support create-case \ --category-code
"using-aws"
\ --cc-email-addresses"myemail@example.com"
\ --communication-body"I want to learn more about an AWS service."
\ --issue-type"technical"
\ --language"en"
\ --service-code"general-info"
\ --severity-code"low"
\ --subject"Question about my account"
Salida:
{ "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47" }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte CreateCase
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-attachment
.
- AWS CLI
-
Descripción de un archivo adjunto
El siguiente ejemplo de
describe-attachment
devuelve información sobre el archivo adjunto con el ID especificado.aws support describe-attachment \ --attachment-id
"attachment-KBnjRNrePd9D6Jx0-Mm00xZuDEaL2JAj_0-gJv9qqDooTipsz3V1Nb19rCfkZneeQeDPgp8X1iVJyHH7UuhZDdNeqGoduZsPrAhyMakqlc60-iJjL5HqyYGiT1FG8EXAMPLE"
Salida:
{ "attachment": { "fileName": "troubleshoot-screenshot.png", "data": "base64-blob" } }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte DescribeAttachment
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-cases
.
- AWS CLI
-
Descripción de un caso
En el siguiente ejemplo de
describe-cases
se devuelve información sobre el caso de soporte especificado en su cuenta de AWS.aws support describe-cases \ --display-id
"1234567890"
\ --after-time"2020-03-23T21:31:47.774Z"
\ --include-resolved-cases \ --language"en"
\ --no-include-communications \ --max-item1
Salida:
{ "cases": [ { "status": "resolved", "ccEmailAddresses": [], "timeCreated": "2020-03-23T21:31:47.774Z", "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47", "severityCode": "low", "language": "en", "categoryCode": "using-aws", "serviceCode": "general-info", "submittedBy": "myemail@example.com", "displayId": "1234567890", "subject": "Question about my account" } ] }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte DescribeCases
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-communications
.
- AWS CLI
-
Descripción de la última comunicación de un caso
En el siguiente ejemplo de
describe-communications
se devuelve la última comunicación del caso de soporte especificado en su cuenta de AWS.aws support describe-communications \ --case-id
"case-12345678910-2013-c4c1d2bf33c5cf47"
\ --after-time"2020-03-23T21:31:47.774Z"
\ --max-item1
Salida:
{ "communications": [ { "body": "I want to learn more about an AWS service.", "attachmentSet": [], "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47", "timeCreated": "2020-05-12T23:12:35.000Z", "submittedBy": "Amazon Web Services" } ], "NextToken": "eyJuZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQEXAMPLE==" }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte DescribeCommunications
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-services
.
- AWS CLI
-
Creación de una lista de los servicios y las categorías de servicios de AWS
En el siguiente ejemplo de
describe-services
se enumeran las categorías de servicios disponibles para solicitar información general.aws support describe-services \ --service-code-list
"general-info"
Salida:
{ "services": [ { "code": "general-info", "name": "General Info and Getting Started", "categories": [ { "code": "charges", "name": "How Will I Be Charged?" }, { "code": "gdpr-queries", "name": "Data Privacy Query" }, { "code": "reserved-instances", "name": "Reserved Instances" }, { "code": "resource", "name": "Where is my Resource?" }, { "code": "using-aws", "name": "Using AWS & Services" }, { "code": "free-tier", "name": "Free Tier" }, { "code": "security-and-compliance", "name": "Security & Compliance" }, { "code": "account-structure", "name": "Account Structure" } ] } ] }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte DescribeServices
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-severity-levels
.
- AWS CLI
-
Creación de una lista de los niveles de gravedad disponibles
En el siguiente ejemplo de
describe-severity-levels
se enumeran los niveles de gravedad disponibles para un caso de soporte.aws support describe-severity-levels
Salida:
{ "severityLevels": [ { "code": "low", "name": "Low" }, { "code": "normal", "name": "Normal" }, { "code": "high", "name": "High" }, { "code": "urgent", "name": "Urgent" }, { "code": "critical", "name": "Critical" } ] }
Para obtener más información, consulte Elección de la gravedad en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte DescribeSeverityLevels
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-trusted-advisor-check-refresh-statuses
.
- AWS CLI
-
Para enumerar los estados de actualización de las comprobaciones de AWS Trusted Advisor
En el siguiente ejemplo de
describe-trusted-advisor-check-refresh-statuses
, se muestran los estados de actualización de dos comprobaciones de Trusted Advisor: Permisos de bucket de Amazon S3 y Uso de IAM.aws support describe-trusted-advisor-check-refresh-statuses \ --check-id
"Pfx0RwqBli"
"zXCkfM1nI3"
Salida:
{ "statuses": [ { "checkId": "Pfx0RwqBli", "status": "none", "millisUntilNextRefreshable": 0 }, { "checkId": "zXCkfM1nI3", "status": "none", "millisUntilNextRefreshable": 0 } ] }
Para obtener más información, consulte AWS Trusted Advisor en la Guía del usuario de AWS Support.
-
Para obtener información sobre la API, consulte DescribeTrustedAdvisorCheckRefreshStatuses
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-trusted-advisor-check-result
.
- AWS CLI
-
Para enumerar los resultados de una comprobación de AWS Trusted Advisor
En el siguiente ejemplo de
describe-trusted-advisor-check-result
, se muestran los resultados de la comprobación de Uso de IAM.aws support describe-trusted-advisor-check-result \ --check-id
"zXCkfM1nI3"
Salida:
{ "result": { "checkId": "zXCkfM1nI3", "timestamp": "2020-05-13T21:38:05Z", "status": "ok", "resourcesSummary": { "resourcesProcessed": 1, "resourcesFlagged": 0, "resourcesIgnored": 0, "resourcesSuppressed": 0 }, "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } }, "flaggedResources": [ { "status": "ok", "resourceId": "47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZEXAMPLE", "isSuppressed": false } ] } }
Para obtener más información, consulte AWS Trusted Advisor en la Guía del usuario de AWS Support.
-
Para obtener información sobre la API, consulte DescribeTrustedAdvisorCheckResult
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-trusted-advisor-check-summaries
.
- AWS CLI
-
Para enumerar los resúmenes de las comprobaciones de AWS Trusted Advisor
En el siguiente ejemplo de
describe-trusted-advisor-check-summaries
, se muestran los resultados de dos comprobaciones de Trusted Advisor: Permisos de bucket de Amazon S3 y Uso de IAM.aws support describe-trusted-advisor-check-summaries \ --check-ids
"Pfx0RwqBli"
"zXCkfM1nI3"
Salida:
{ "summaries": [ { "checkId": "Pfx0RwqBli", "timestamp": "2020-05-13T21:38:12Z", "status": "ok", "hasFlaggedResources": true, "resourcesSummary": { "resourcesProcessed": 44, "resourcesFlagged": 0, "resourcesIgnored": 0, "resourcesSuppressed": 0 }, "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } } }, { "checkId": "zXCkfM1nI3", "timestamp": "2020-05-13T21:38:05Z", "status": "ok", "hasFlaggedResources": true, "resourcesSummary": { "resourcesProcessed": 1, "resourcesFlagged": 0, "resourcesIgnored": 0, "resourcesSuppressed": 0 }, "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } } } ] }
Para obtener más información, consulte AWS Trusted Advisor en la Guía del usuario de AWS Support.
-
Para obtener información sobre la API, consulte DescribeTrustedAdvisorCheckSummaries
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar describe-trusted-advisor-checks
.
- AWS CLI
-
Para enumerar las comprobaciones de AWS Trusted Advisor disponibles
En el siguiente ejemplo de
describe-trusted-advisor-checks
, se enumeran las comprobaciones de Trusted Advisor disponibles en su cuenta de AWS. Esta información incluye el nombre, el ID, la descripción, la categoría y los metadatos del cheque. Tenga en cuenta que el resultado se abrevia para que se pueda leer.aws support describe-trusted-advisor-checks \ --language
"en"
Salida:
{ "checks": [ { "id": "zXCkfM1nI3", "name": "IAM Use", "description": "Checks for your use of AWS Identity and Access Management (IAM). You can use IAM to create users, groups, and roles in AWS, and you can use permissions to control access to AWS resources. \n<br>\n<br>\n<b>Alert Criteria</b><br>\nYellow: No IAM users have been created for this account.\n<br>\n<br>\n<b>Recommended Action</b><br>\nCreate one or more IAM users and groups in your account. You can then create additional users whose permissions are limited to perform specific tasks in your AWS environment. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/IAMGettingStarted.html\" target=\"_blank\">Getting Started</a>. \n<br><br>\n<b>Additional Resources</b><br>\n<a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_Introduction.html\" target=\"_blank\">What Is IAM?</a>", "category": "security", "metadata": [] } ] }
Para obtener más información, consulte AWS Trusted Advisor en la Guía del usuario de AWS Support.
-
Para obtener información sobre la API, consulte DescribeTrustedAdvisorChecks
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar refresh-trusted-advisor-check
.
- AWS CLI
-
Para actualizar una comprobación de AWS Trusted Advisor
En el siguiente ejemplo de
refresh-trusted-advisor-check
, se actualiza la comprobación Permisos del bucket de Amazon S3 de Trusted Advisor en su cuenta de AWS.aws support refresh-trusted-advisor-check \ --check-id
"Pfx0RwqBli"
Salida:
{ "status": { "checkId": "Pfx0RwqBli", "status": "enqueued", "millisUntilNextRefreshable": 3599992 } }
Para obtener más información, consulte AWS Trusted Advisor en la Guía del usuario de AWS Support.
-
Para ver los detalles de la API, consulte RefreshTrustedAdvisorCheck
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar resolve-case
.
- AWS CLI
-
Resolución de un caso de soporte
En el siguiente ejemplo de
resolve-case
se resuelve un caso de soporte en su cuenta de AWS.aws support resolve-case \ --case-id
"case-12345678910-2013-c4c1d2bf33c5cf47"
Salida:
{ "finalCaseStatus": "resolved", "initialCaseStatus": "work-in-progress" }
Para obtener más información, consulte Administración de casos en la Guía del usuario de soporte de AWS.
-
Para obtener información sobre la API, consulte ResolveCase
en la Referencia de comandos de la AWS CLI.
-