Visualização organizacional (CLI)

Você também pode ativar o recurso de visualização organizacional a partir do AWS Command Line Interface (AWS CLI) em vez do console AWS Health. Para usar o console, consulte Habilitar a visualização organizacional (console).

nota

Se você quiser permitir que os usuários acessem a conta de gerenciamento do recurso de visualização organizacional, eles devem ter permissões, como a política AWSHealthFullAccess. Para obter mais informações, consulte AWS Health exemplos de políticas baseadas em identidade.

Sumário

• Habilitar a visualização organizacional (CLI)
• Visualizar eventos de visualização organizacional (CLI)
• Desabilitar a visualização organizacional (CLI)
• Operações da API da visualização organizacional do AWS Health

Habilitar a visualização organizacional (CLI)

Você só pode habilitar a visualização organizacional usando a operação da API EnableHealthServiceAccessForOrganization

É possível usar a AWS Command Line Interface (AWS CLI) ou seu próprio código para chamar essa operação.

nota

• É necessário ter um plano de suporte Business, Enterprise On-Ramp, ou Enterprise para chamar a API AWS Health.

• Você deve usar o endpoint da região Leste dos EUA (Norte da Virgínia).

O comando da AWS CLI a seguir habilita esse recurso na conta da AWS. É possível usar esse comando na conta de gerenciamento ou em uma conta que possa assumir a função com as permissões necessárias.

aws health enable-health-service-access-for-organization --region us-east-1

Os exemplos de código a seguir chamam a operação da API EnableHealthServiceAccessForOrganization.

Python

import boto3

client = boto3.client('health')

response = client.enable_health_service_access_for_organization()

print(response)

Java

É possível usar o AWS SDK para a versão Java 2.0 para o exemplo a seguir.

import software.amazon.awssdk.services.health.HealthClient;
import software.amazon.awssdk.services.health.HealthClientBuilder;
 
import software.amazon.awssdk.services.health.model.ConcurrentModificationException;
import software.amazon.awssdk.services.health.model.EnableHealthServiceAccessForOrganizationRequest;
import software.amazon.awssdk.services.health.model.EnableHealthServiceAccessForOrganizationResponse;
import software.amazon.awssdk.services.health.model.DescribeHealthServiceStatusForOrganizationRequest;
import software.amazon.awssdk.services.health.model.DescribeHealthServiceStatusForOrganizationResponse;
 
import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
 
import software.amazon.awssdk.regions.Region;
 
public class EnableHealthServiceAccessDemo {
    public static void main(String[] args) {
        HealthClient client = HealthClient.builder()
            .region(Region.US_EAST_1)
            .credentialsProvider(
                DefaultCredentialsProvider.builder().build()
            )
            .build();
 
        try {
            DescribeHealthServiceStatusForOrganizationResponse statusResponse = client.describeHealthServiceStatusForOrganization(
                DescribeHealthServiceStatusForOrganizationRequest.builder().build()
            );
 
            String status = statusResponse.healthServiceAccessStatusForOrganization();
            if ("ENABLED".equals(status)) {
                System.out.println("EnableHealthServiceAccessForOrganization already enabled!");
                return;
            }
 
            client.enableHealthServiceAccessForOrganization(
                EnableHealthServiceAccessForOrganizationRequest.builder().build()
            );
 
            System.out.println("EnableHealthServiceAccessForOrganization is in progress");
        } catch (ConcurrentModificationException cme) {
            System.out.println("EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again.");
        } catch (Exception e) {
            System.out.println("EnableHealthServiceAccessForOrganization FAILED: " + e);
        }
    }
}

Para obter mais informações, consulte o Guia do desenvolvedor do AWS SDK para Java 2.0.

Ao habilitar esse atributo, uma AWSServiceRoleForHealth_Organizationsfunção vinculada ao serviço (SLR) com a Health_OrganizationsServiceRolePolicy AWS política gerenciada é aplicada à conta gerenciada na organização.

nota

A habilitação desse recurso é um processo assíncrono e leva um tempo para ser concluída. É possível chamar a operação DescribeHealthServiceStatusForOrganization para verificar o status do processo.

Visualizar eventos de visualização organizacional (CLI)

Depois de habilitar esse recurso, o AWS Health começa a registar eventos que afetam as contas na organização. Quando uma conta ingressa na organização, o AWS Health a adiciona automaticamente à visualização organizacional.

nota

O AWS Health não registra eventos que ocorreram na organização antes da habilitação da visualização organizacional.

Quando uma conta sai da organização, novos eventos dessa conta não são mais registrados em log na visualização organizacional. No entanto, os eventos existentes permanecem e você ainda pode consultá-los por até 90 dias.

A AWS manterá os dados da política da conta por 90 dias a partir da data efetiva de encerramento da conta de administrador. Ao final do período de 90 dias, a AWS exclui permanentemente todos os dados de política da conta.

• Para reter as descobertas por mais de 90 dias, você pode arquivar as políticas. Você também pode usar uma ação personalizada com uma regra do EventBridge para armazenar as descobertas em um bucket do S3.

• Contanto que a AWS retenha os dados da política, quando você reabrir a conta, a AWS reatribuirá a conta como administrador do serviço e recuperará os dados da política de serviço da conta.

• Para obter mais informações, consulte Encerrar uma conta.

Importante

Para clientes nas regiões do AWS GovCloud (US):

• Antes de fechar sua conta, faça backup e, em seguida, exclua os dados da política e outros recursos da conta. Você não terá mais acesso a eles depois de fechar a conta.

É possível usar as operações da API do AWS Health para retornar eventos da visualização organizacional.

exemplo : Descrever eventos da visualização organizacional

O seguinte comando da AWS CLI retorna eventos de integridade de contas da AWS na organização.

aws health describe-events-for-organization --region us-east-1

Consulte a seção a seguir para obter outras operações da API do AWS Health.

Desabilitar a visualização organizacional (CLI)

Você pode desabilitar a visualização organizacional usando a operação da API DisableHealthServiceAccessForOrganization.

O comando da AWS CLI a seguir desabilita esse recurso da sua conta.

aws health disable-health-service-access-for-organization --region us-east-1

nota

Você pode desabilitar a visualização organizacional usando a operação da API DisableAWSServiceAccess. Depois que você chama essa operação, o AWS Health para de agregar eventos de todas as outras contas em sua organização. Se você chamar as operações da API AWS Health para visualização organizacional, o AWS Health retornará um erro. O AWS Health continua a agregar eventos de integridade de sua conta da AWS.

Depois que esse recurso ´é desabilitado, o AWS Health não agrega mais eventos de sua organização. No entanto, a função vinculada ao serviço permanecerá na conta de gerenciamento da organização até que você a remova por meio do console AWS Identity and Access Management do IAM, da API do IAM do ou da AWS CLI. Para obter mais informações, consulte Excluir uma função vinculada ao serviço no Guia do usuário do IAM.

Operações da API da visualização organizacional do AWS Health

É possível usar as seguintes operações da API do AWS Health para a visualização organizacional:

• DescribeEventsForOrganization: retorna as informações resumidas sobre eventos em toda a organização.

• DescribeAffectedAccountsForAWS retorna uma lista de contas de da organização que são afetadas pelo evento fornecido.

• DescribeEventDetailsForOrganization – retorna informações detalhadas sobre um ou mais eventos especificados para uma ou mais contas no .

• DescribeAffectedEntitiesForOrganization retorna uma lista de entidades que foram afetadas por um ou mais eventos para uma ou mais contas em uma organização.

É possível usar as seguintes operações para habilitar ou desabilitar o AWS Health para trabalhar com as organizações.

• EnableHealthServiceAccessForOrganization: concede permissão de AWS Health para interagir com Organizações e aplica a SLR à conta de gerenciamento na organização.

• DisableHealthServiceAccessForOrganization: revoga a permissão para interagir com as organizações. AWS Health

• DescribeHealthServiceStatusForOrganization: retorna informações de status sobre se AWS Health está habilitado para sua organização.

É necessário ter um plano de suporte Business, Enterprise On-Ramp, ou Enterprise para usar essas opções de API. Se você chamar as operações DescribeEventForOrganization e DescribeAffectedAccountsForOrganization de uma conta que tenha pelo menos um plano de suporte Business, poderá retornar informações sobre qualquer conta na organização, independentemente do nível de suporte das contas individuais. Veja os exemplos a seguir.

exemplo Exemplo: uma organização com contas que têm planos de suporte Business e para Desenvolvedores

• Você tem três contas em sua organização. A conta de gerenciamento tem um plano de suporte Business e as outras duas contas têm um plano de suporte de Desenvolvedor.

• Você chama a operação da API DescribeEventForOrganization da conta de gerenciamento ou de uma conta que pode assumir a função com as permissões necessárias.

• O AWS Health retorna informações de todas as três contas.

Se você chamar as operações da API DescribeEventDetailsForOrganization e DescribeAffectedEntitiesForOrganization de uma conta que tenha pelo menos um plano de suporte Business, só poderá retornar informações sobre contas na organização que tenham um plano de suporte Business, Enterprise On-Ramp, ou Enterprise.

exemplo Exemplo: uma organização com contas que têm planos de suporte Enterprise, Business e Desenvolvedor

• Você tem cinco contas em sua organização. A conta de gerenciamento da tem um plano de suporte Enterprise, duas contas têm um plano de suporte Business e duas contas têm um plano de suporte Desenvolvedor.

• Chamar a operação da API DescribeEventDetailsForOrganization da conta de gerenciamento.

• O AWS Health retorna informações somente das contas que têm um plano de suporte Enterprise ou Business. As contas que têm um plano de suporte Desenvolvedor aparecem no failedSet da resposta.