AWS Support exemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS Support.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar add-attachments-to-set.

AWS CLI

Para adicionar um anexo a um conjunto

O add-attachments-to-set exemplo a seguir adiciona uma imagem a um conjunto que você pode especificar para um caso de suporte em sua AWS conta.


aws support add-attachments-to-set \
    --attachment-set-id "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE" \
    --attachments fileName=troubleshoot-screenshot.png,data=base64-encoded-string

Saída:


{
    "attachmentSetId": "as-2f5a6faa2a4a1e600-mu-nk5xQlBr70-G1cUos5LZkd38KOAHZa9BMDVzNEXAMPLE",
    "expiryTime": "2020-05-14T17:04:40.790+0000"
}

Para obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte AddAttachmentsToSetna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar add-communication-to-case.

AWS CLI

Para adicionar comunicação a um caso

O add-communication-to-case exemplo a seguir adiciona comunicações a um caso de suporte em sua AWS conta.


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"

Saída:


{
    "result": true
}

Para obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte AddCommunicationToCasena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-case.

AWS CLI

Como criar um caso

O create-case exemplo a seguir cria um caso de suporte para sua AWS conta.


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"

Saída:


{
    "caseId": "case-12345678910-2013-c4c1d2bf33c5cf47"
}

Para obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte CreateCasena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-attachment.

AWS CLI

Como descrever um anexo

O exemplo de describe-attachment a seguir retorna informações sobre o anexo com o ID especificado.


aws support describe-attachment \
    --attachment-id "attachment-KBnjRNrePd9D6Jx0-Mm00xZuDEaL2JAj_0-gJv9qqDooTipsz3V1Nb19rCfkZneeQeDPgp8X1iVJyHH7UuhZDdNeqGoduZsPrAhyMakqlc60-iJjL5HqyYGiT1FG8EXAMPLE"

Saída:


{
    "attachment": {
        "fileName": "troubleshoot-screenshot.png",
        "data": "base64-blob"
    }
}

Para obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte DescribeAttachmentna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-cases.

AWS CLI

Como descrever um caso

O describe-cases exemplo a seguir retorna informações sobre o caso de suporte especificado em sua AWS conta.


aws support describe-cases \
    --display-id "1234567890" \
    --after-time "2020-03-23T21:31:47.774Z" \
    --include-resolved-cases \
    --language "en" \
    --no-include-communications \
    --max-item 1

Saída:


{
    "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 obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte DescribeCasesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-communications.

AWS CLI

Como descrever a comunicação mais recente de um caso

O describe-communications exemplo a seguir retorna a comunicação mais recente para o caso de suporte especificado em sua AWS conta.


aws support describe-communications \
    --case-id "case-12345678910-2013-c4c1d2bf33c5cf47" \
    --after-time "2020-03-23T21:31:47.774Z" \
    --max-item 1

Saída:


{
    "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 obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte DescribeCommunicationsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-services.

AWS CLI

Para listar AWS serviços e categorias de serviços

O exemplo de describe-services a seguir lista as categorias de serviço disponíveis para a solicitação de informações gerais.


aws support describe-services \
    --service-code-list "general-info"

Saída:


{
    "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 obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte DescribeServicesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-severity-levels.

AWS CLI

Como listar os níveis de gravidade disponíveis

O exemplo de describe-severity-levels a seguir lista os níveis de gravidade disponíveis para um caso de suporte.


aws support describe-severity-levels

Saída:


{
    "severityLevels": [
        {
            "code": "low",
            "name": "Low"
        },
        {
            "code": "normal",
            "name": "Normal"
        },
        {
            "code": "high",
            "name": "High"
        },
        {
            "code": "urgent",
            "name": "Urgent"
        },
        {
            "code": "critical",
            "name": "Critical"
        }
    ]
}

Para obter mais informações, consulte Choosing a severity no Guia do usuário do AWS Support.

Para API obter detalhes, consulte DescribeSeverityLevelsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-trusted-advisor-check-refresh-statuses.

AWS CLI

Para listar os status de atualização das verificações do AWS Trusted Advisor

O describe-trusted-advisor-check-refresh-statuses exemplo a seguir lista os status de atualização de duas verificações do Trusted Advisor: Amazon S3 Bucket Permissions and Use. IAM


aws support describe-trusted-advisor-check-refresh-statuses \
    --check-id "Pfx0RwqBli" "zXCkfM1nI3"

Saída:


{
    "statuses": [
        {
            "checkId": "Pfx0RwqBli",
            "status": "none",
            "millisUntilNextRefreshable": 0
        },
        {
            "checkId": "zXCkfM1nI3",
            "status": "none",
            "millisUntilNextRefreshable": 0
        }
    ]
}

Para obter mais informações, consulte AWS Trusted Advisor no AWS Support User Guide.

Para API obter detalhes, consulte DescribeTrustedAdvisorCheckRefreshStatusesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-trusted-advisor-check-result.

AWS CLI

Para listar os resultados de uma verificação do AWS Trusted Advisor

O describe-trusted-advisor-check-result exemplo a seguir lista os resultados da verificação de IAM uso.


aws support describe-trusted-advisor-check-result \
    --check-id "zXCkfM1nI3"

Saída:


{
    "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 obter mais informações, consulte AWS Trusted Advisor no AWS Support User Guide.

Para API obter detalhes, consulte DescribeTrustedAdvisorCheckResultna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-trusted-advisor-check-summaries.

AWS CLI

Para listar os resumos das verificações do AWS Trusted Advisor

O describe-trusted-advisor-check-summaries exemplo a seguir lista os resultados de duas verificações do Trusted Advisor: Amazon S3 Bucket Permissions and IAM Use.


aws support describe-trusted-advisor-check-summaries \
    --check-ids "Pfx0RwqBli" "zXCkfM1nI3"

Saída:


{
    "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 obter mais informações, consulte AWS Trusted Advisor no AWS Support User Guide.

Para API obter detalhes, consulte DescribeTrustedAdvisorCheckSummariesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-trusted-advisor-checks.

AWS CLI

Para listar as verificações disponíveis do AWS Trusted Advisor

O describe-trusted-advisor-checks exemplo a seguir lista os cheques do Trusted Advisor disponíveis em sua AWS conta. Essas informações incluem o nome, ID, descrição, categoria e metadados do cheque. Observe que a saída é reduzida para facilitar a leitura.


aws support describe-trusted-advisor-checks \
    --language "en"

Saída:


{
    "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 obter mais informações, consulte AWS Trusted Advisor no AWS Support User Guide.

Para API obter detalhes, consulte DescribeTrustedAdvisorChecksna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar refresh-trusted-advisor-check.

AWS CLI

Para atualizar uma verificação do AWS Trusted Advisor

O refresh-trusted-advisor-check exemplo a seguir atualiza o cheque do Amazon S3 Bucket Permissions Trusted Advisor em AWS sua conta.


aws support refresh-trusted-advisor-check \
    --check-id "Pfx0RwqBli"

Saída:


{
    "status": {
        "checkId": "Pfx0RwqBli",
        "status": "enqueued",
        "millisUntilNextRefreshable": 3599992
    }
}

Para obter mais informações, consulte AWS Trusted Advisor no AWS Support User Guide.

Para API obter detalhes, consulte RefreshTrustedAdvisorCheckna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar resolve-case.

AWS CLI

Como solucionar um caso de suporte

O resolve-case exemplo a seguir resolve um caso de suporte em sua AWS conta.


aws support resolve-case \
    --case-id "case-12345678910-2013-c4c1d2bf33c5cf47"

Saída:


{
    "finalCaseStatus": "resolved",
    "initialCaseStatus": "work-in-progress"
}

Para obter mais informações, consulte Case management no Guia do usuário do AWS Support.

Para API obter detalhes, consulte ResolveCasena Referência de AWS CLI Comandos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

AWS STS

Amazon SWF