As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Exemplos de código para AWS Config usar AWS SDKs
Os exemplos de código a seguir mostram como usar AWS Config com um kit AWS de desenvolvimento de software (SDK).
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
**Contents**
+ [Conceitos básicos](service_code_examples_basics.md)
+ [Ações](service_code_examples_actions.md)
+ [`DeleteConfigRule`](example_config-service_DeleteConfigRule_section.md)
+ [`DescribeComplianceByConfigRule`](example_config-service_DescribeComplianceByConfigRule_section.md)
+ [`DescribeComplianceByResource`](example_config-service_DescribeComplianceByResource_section.md)
+ [`DescribeConfigRuleEvaluationStatus`](example_config-service_DescribeConfigRuleEvaluationStatus_section.md)
+ [`DescribeConfigRules`](example_config-service_DescribeConfigRules_section.md)
+ [`DescribeConfigurationRecorderStatus`](example_config-service_DescribeConfigurationRecorderStatus_section.md)
+ [`DescribeConfigurationRecorders`](example_config-service_DescribeConfigurationRecorders_section.md)
+ [`DescribeDeliveryChannels`](example_config-service_DescribeDeliveryChannels_section.md)
+ [`GetComplianceDetailsByConfigRule`](example_config-service_GetComplianceDetailsByConfigRule_section.md)
+ [`GetComplianceDetailsByResource`](example_config-service_GetComplianceDetailsByResource_section.md)
+ [`GetComplianceSummaryByConfigRule`](example_config-service_GetComplianceSummaryByConfigRule_section.md)
+ [`GetComplianceSummaryByResourceType`](example_config-service_GetComplianceSummaryByResourceType_section.md)
+ [`PutConfigRule`](example_config-service_PutConfigRule_section.md)
+ [`PutDeliveryChannel`](example_config-service_PutDeliveryChannel_section.md)
# Exemplos básicos de AWS Config uso AWS SDKs
Os exemplos de código a seguir mostram como usar o básico do AWS Config with AWS SDKs.
**Contents**
+ [Ações](service_code_examples_actions.md)
+ [`DeleteConfigRule`](example_config-service_DeleteConfigRule_section.md)
+ [`DescribeComplianceByConfigRule`](example_config-service_DescribeComplianceByConfigRule_section.md)
+ [`DescribeComplianceByResource`](example_config-service_DescribeComplianceByResource_section.md)
+ [`DescribeConfigRuleEvaluationStatus`](example_config-service_DescribeConfigRuleEvaluationStatus_section.md)
+ [`DescribeConfigRules`](example_config-service_DescribeConfigRules_section.md)
+ [`DescribeConfigurationRecorderStatus`](example_config-service_DescribeConfigurationRecorderStatus_section.md)
+ [`DescribeConfigurationRecorders`](example_config-service_DescribeConfigurationRecorders_section.md)
+ [`DescribeDeliveryChannels`](example_config-service_DescribeDeliveryChannels_section.md)
+ [`GetComplianceDetailsByConfigRule`](example_config-service_GetComplianceDetailsByConfigRule_section.md)
+ [`GetComplianceDetailsByResource`](example_config-service_GetComplianceDetailsByResource_section.md)
+ [`GetComplianceSummaryByConfigRule`](example_config-service_GetComplianceSummaryByConfigRule_section.md)
+ [`GetComplianceSummaryByResourceType`](example_config-service_GetComplianceSummaryByResourceType_section.md)
+ [`PutConfigRule`](example_config-service_PutConfigRule_section.md)
+ [`PutDeliveryChannel`](example_config-service_PutDeliveryChannel_section.md)
# Ações para AWS Config usar AWS SDKs
Os exemplos de código a seguir demonstram como realizar AWS Config ações individuais com AWS SDKs. Cada exemplo inclui um link para GitHub, onde você pode encontrar instruções para configurar e executar o código.
Os exemplos a seguir incluem apenas as ações mais utilizadas. Para obter uma lista completa, consulte a [Referência de APIs do AWS Config](https://docs.aws.amazon.com/config/latest/APIReference/Welcome.html).
**Topics**
+ [`DeleteConfigRule`](example_config-service_DeleteConfigRule_section.md)
+ [`DescribeComplianceByConfigRule`](example_config-service_DescribeComplianceByConfigRule_section.md)
+ [`DescribeComplianceByResource`](example_config-service_DescribeComplianceByResource_section.md)
+ [`DescribeConfigRuleEvaluationStatus`](example_config-service_DescribeConfigRuleEvaluationStatus_section.md)
+ [`DescribeConfigRules`](example_config-service_DescribeConfigRules_section.md)
+ [`DescribeConfigurationRecorderStatus`](example_config-service_DescribeConfigurationRecorderStatus_section.md)
+ [`DescribeConfigurationRecorders`](example_config-service_DescribeConfigurationRecorders_section.md)
+ [`DescribeDeliveryChannels`](example_config-service_DescribeDeliveryChannels_section.md)
+ [`GetComplianceDetailsByConfigRule`](example_config-service_GetComplianceDetailsByConfigRule_section.md)
+ [`GetComplianceDetailsByResource`](example_config-service_GetComplianceDetailsByResource_section.md)
+ [`GetComplianceSummaryByConfigRule`](example_config-service_GetComplianceSummaryByConfigRule_section.md)
+ [`GetComplianceSummaryByResourceType`](example_config-service_GetComplianceSummaryByResourceType_section.md)
+ [`PutConfigRule`](example_config-service_PutConfigRule_section.md)
+ [`PutDeliveryChannel`](example_config-service_PutDeliveryChannel_section.md)
# Use `DeleteConfigRule` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `DeleteConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Para excluir uma regra de AWS Config**
O comando a seguir exclui uma regra de AWS Config chamada: `MyConfigRule`
```
aws configservice delete-config-rule --config-rule-name MyConfigRule
```
+ Para obter detalhes da API, consulte [DeleteConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-config-rule.html)em *Referência de AWS CLI Comandos*.
------
#### [ Python ]
**SDK para Python (Boto3)**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/config#code-examples).
```
class ConfigWrapper:
"""
Encapsulates AWS Config functions.
"""
def __init__(self, config_client):
"""
:param config_client: A Boto3 AWS Config client.
"""
self.config_client = config_client
def delete_config_rule(self, rule_name):
"""
Delete the specified rule.
:param rule_name: The name of the rule to delete.
"""
try:
self.config_client.delete_config_rule(ConfigRuleName=rule_name)
logger.info("Deleted rule %s.", rule_name)
except ClientError:
logger.exception("Couldn't delete rule %s.", rule_name)
raise
```
+ Para obter detalhes da API, consulte a [DeleteConfigRule](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/DeleteConfigRule)Referência da API *AWS SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cfs#code-examples).
```
lo_cfs->deleteconfigrule( iv_rule_name ).
MESSAGE 'Deleted AWS Config rule.' TYPE 'I'.
```
+ Para obter detalhes da API, consulte a [DeleteConfigRule](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `DescribeComplianceByConfigRule` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeComplianceByConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Para obter informações de conformidade para suas regras de AWS Config**
O comando a seguir retorna informações de conformidade para cada regra AWS do Config violada por um ou mais recursos: AWS
```
aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT
```
Na saída, o valor de cada atributo `CappedCount` indica quantos recursos não estão em conformidade com a regra relacionada. Por exemplo, a saída a seguir indica que três recursos não estão em conformidade com a regra chamada `InstanceTypesAreT2micro`.
Saída:
```
{
"ComplianceByConfigRules": [
{
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
},
"ConfigRuleName": "InstanceTypesAreT2micro"
},
{
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 10,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
},
"ConfigRuleName": "RequiredTagsForVolumes"
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeComplianceByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-config-rule.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: Este exemplo recupera detalhes de conformidade da regra ebs-optimized-instance, para os quais não há resultados de avaliação atuais para a regra, portanto, retorna INSUFFICIENT\$1DATA**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**Saída**:
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**Exemplo 2: este exemplo retorna o número de recursos que não estão em conformidade com a regra ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK.**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ Para obter detalhes da API, consulte [DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo recupera detalhes de conformidade da regra ebs-optimized-instance, para os quais não há resultados de avaliação atuais para a regra, portanto, retorna INSUFFICIENT\$1DATA**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**Saída**:
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**Exemplo 2: este exemplo retorna o número de recursos que não estão em conformidade com a regra ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK.**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ Para obter detalhes da API, consulte [DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `DescribeComplianceByResource` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeComplianceByResource`.
------
#### [ CLI ]
**AWS CLI**
**Para obter informações de conformidade para seus AWS recursos**
O comando a seguir retorna informações de conformidade para cada instância do EC2 que é registrada pelo AWS Config e que viola uma ou mais regras:
```
aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT
```
Na saída, o valor de cada atributo `CappedCount` indica quantas regras o recurso viola. Por exemplo, a saída a seguir indica que a instância `i-1a2b3c4d` viola duas regras.
Saída:
```
{
"ComplianceByResources": [
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 2,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
},
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d ",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeComplianceByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-resource.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo verifica o tipo de recurso `AWS::SSM::ManagedInstanceInventory` quanto ao tipo de conformidade “COMPLIANT”.**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**Saída**:
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ Para obter detalhes da API, consulte [DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo verifica o tipo de recurso `AWS::SSM::ManagedInstanceInventory` quanto ao tipo de conformidade “COMPLIANT”.**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**Saída**:
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ Para obter detalhes da API, consulte [DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `DescribeConfigRuleEvaluationStatus` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeConfigRuleEvaluationStatus`.
------
#### [ CLI ]
**AWS CLI**
**Para obter informações de status de uma regra AWS Config**
O comando a seguir retorna as informações de status de uma regra AWS Config chamada: `MyConfigRule`
```
aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule
```
Saída:
```
{
"ConfigRulesEvaluationStatus": [
{
"ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
"FirstActivatedTime": 1450311703.844,
"ConfigRuleId": "config-rule-abcdef",
"LastSuccessfulInvocationTime": 1450314643.156,
"ConfigRuleName": "MyConfigRule"
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeConfigRuleEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rule-evaluation-status.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo retorna as informações de status das regras de configuração fornecidas. **
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**Saída**:
```
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-kvq1wk
ConfigRuleId : config-rule-kvq1wk
ConfigRuleName : root-account-mfa-enabled
FirstActivatedTime : 8/27/2019 8:05:17 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 8:12:03 AM
LastSuccessfulInvocationTime : 12/13/2019 8:12:03 AM
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-z1s23b
ConfigRuleId : config-rule-z1s23b
ConfigRuleName : vpc-flow-logs-enabled
FirstActivatedTime : 8/14/2019 6:23:44 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 7:12:01 AM
LastSuccessfulInvocationTime : 12/13/2019 7:12:01 AM
```
+ Para obter detalhes da API, consulte [DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna as informações de status das regras de configuração fornecidas. **
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**Saída**:
```
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-kvq1wk
ConfigRuleId : config-rule-kvq1wk
ConfigRuleName : root-account-mfa-enabled
FirstActivatedTime : 8/27/2019 8:05:17 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 8:12:03 AM
LastSuccessfulInvocationTime : 12/13/2019 8:12:03 AM
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-z1s23b
ConfigRuleId : config-rule-z1s23b
ConfigRuleName : vpc-flow-logs-enabled
FirstActivatedTime : 8/14/2019 6:23:44 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 7:12:01 AM
LastSuccessfulInvocationTime : 12/13/2019 7:12:01 AM
```
+ Para obter detalhes da API, consulte [DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `DescribeConfigRules` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `DescribeConfigRules`.
------
#### [ CLI ]
**AWS CLI**
**Para obter detalhes de uma regra de AWS Config**
O comando a seguir retorna detalhes de uma regra de AWS Config chamada: `InstanceTypesAreT2micro`
```
aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro
```
Saída:
```
{
"ConfigRules": [
{
"ConfigRuleState": "ACTIVE",
"Description": "Evaluates whether EC2 instances are the t2.micro type.",
"ConfigRuleName": "InstanceTypesAreT2micro",
"ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
"Source": {
"Owner": "CUSTOM_LAMBDA",
"SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck",
"SourceDetails": [
{
"EventSource": "aws.config",
"MessageType": "ConfigurationItemChangeNotification"
}
]
},
"InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"ConfigRuleId": "config-rule-abcdef"
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeConfigRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rules.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo lista as regras de configuração da conta, com propriedades selecionadas.**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**Saída**:
```
ConfigRuleName ConfigRuleId ConfigRuleArn ConfigRuleState
-------------- ------------ ------------- ---------------
ALB_REDIRECTION_CHECK config-rule-12iyn3 arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-12iyn3 ACTIVE
access-keys-rotated config-rule-aospfr arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-aospfr ACTIVE
autoscaling-group-elb-healthcheck-required config-rule-cn1f2x arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-cn1f2x ACTIVE
```
+ Para obter detalhes da API, consulte [DescribeConfigRules](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo lista as regras de configuração da conta, com propriedades selecionadas.**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**Saída**:
```
ConfigRuleName ConfigRuleId ConfigRuleArn ConfigRuleState
-------------- ------------ ------------- ---------------
ALB_REDIRECTION_CHECK config-rule-12iyn3 arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-12iyn3 ACTIVE
access-keys-rotated config-rule-aospfr arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-aospfr ACTIVE
autoscaling-group-elb-healthcheck-required config-rule-cn1f2x arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-cn1f2x ACTIVE
```
+ Para obter detalhes da API, consulte [DescribeConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
#### [ Python ]
**SDK para Python (Boto3)**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/config#code-examples).
```
class ConfigWrapper:
"""
Encapsulates AWS Config functions.
"""
def __init__(self, config_client):
"""
:param config_client: A Boto3 AWS Config client.
"""
self.config_client = config_client
def describe_config_rule(self, rule_name):
"""
Gets data for the specified rule.
:param rule_name: The name of the rule to retrieve.
:return: The rule data.
"""
try:
response = self.config_client.describe_config_rules(
ConfigRuleNames=[rule_name]
)
rule = response["ConfigRules"]
logger.info("Got data for rule %s.", rule_name)
except ClientError:
logger.exception("Couldn't get data for rule %s.", rule_name)
raise
else:
return rule
```
+ Para obter detalhes da API, consulte a [DescribeConfigRules](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/DescribeConfigRules)Referência da API *AWS SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cfs#code-examples).
```
DATA(lo_result) = lo_cfs->describeconfigrules(
it_configrulenames = VALUE /aws1/cl_cfsconfigrulenames_w=>tt_configrulenames(
( NEW /aws1/cl_cfsconfigrulenames_w( iv_rule_name ) )
)
).
ot_cfg_rules = lo_result->get_configrules( ).
MESSAGE 'Retrieved AWS Config rule data.' TYPE 'I'.
```
+ Para obter detalhes da API, consulte a [DescribeConfigRules](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `DescribeConfigurationRecorderStatus` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeConfigurationRecorderStatus`.
------
#### [ CLI ]
**AWS CLI**
**Para obter informações de status do gravador de configuração**
O seguinte comando retorna o status do gravador de configuração padrão:
```
aws configservice describe-configuration-recorder-status
```
Saída:
```
{
"ConfigurationRecordersStatus": [
{
"name": "default",
"lastStatus": "SUCCESS",
"recording": true,
"lastStatusChangeTime": 1452193834.344,
"lastStartTime": 1441039997.819,
"lastStopTime": 1441039992.835
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorderStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorder-status.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo retorna o status dos gravadores de configuração. **
```
Get-CFGConfigurationRecorderStatus
```
**Saída**:
```
LastErrorCode :
LastErrorMessage :
LastStartTime : 10/11/2019 10:13:51 AM
LastStatus : Success
LastStatusChangeTime : 12/31/2019 6:14:12 AM
LastStopTime : 10/11/2019 10:13:46 AM
Name : default
Recording : True
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o status dos gravadores de configuração. **
```
Get-CFGConfigurationRecorderStatus
```
**Saída**:
```
LastErrorCode :
LastErrorMessage :
LastStartTime : 10/11/2019 10:13:51 AM
LastStatus : Success
LastStatusChangeTime : 12/31/2019 6:14:12 AM
LastStopTime : 10/11/2019 10:13:46 AM
Name : default
Recording : True
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `DescribeConfigurationRecorders` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeConfigurationRecorders`.
------
#### [ CLI ]
**AWS CLI**
**Para obter detalhes sobre o gravador de configuração**
O seguinte comando retorna detalhes sobre o gravador de configuração padrão:
```
aws configservice describe-configuration-recorders
```
Saída:
```
{
"ConfigurationRecorders": [
{
"recordingGroup": {
"allSupported": true,
"resourceTypes": [],
"includeGlobalResourceTypes": true
},
"roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6",
"name": "default"
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorders.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo retorna os detalhes dos gravadores de configuração.**
```
Get-CFGConfigurationRecorder | Format-List
```
**Saída**:
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna os detalhes dos gravadores de configuração.**
```
Get-CFGConfigurationRecorder | Format-List
```
**Saída**:
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `DescribeDeliveryChannels` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeDeliveryChannels`.
------
#### [ CLI ]
**AWS CLI**
**Para obter detalhes sobre o canal de entrega**
O seguinte comando retorna detalhes sobre o canal de entrega:
```
aws configservice describe-delivery-channels
```
Saída:
```
{
"DeliveryChannels": [
{
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"name": "default",
"s3BucketName": "config-bucket-123456789012"
}
]
}
```
+ Para obter detalhes da API, consulte [DescribeDeliveryChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channels.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo recupera o canal de entrega da região e exibe detalhes.**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**Saída**:
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ Para obter detalhes da API, consulte [DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera o canal de entrega da região e exibe detalhes.**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**Saída**:
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ Para obter detalhes da API, consulte [DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `GetComplianceDetailsByConfigRule` com uma CLI
Os exemplos de código a seguir mostram como usar o `GetComplianceDetailsByConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Para obter os resultados da avaliação de uma regra AWS Config**
O comando a seguir retorna os resultados da avaliação de todos os recursos que não estão em conformidade com uma regra de AWS Config chamada: `InstanceTypesAreT2micro`
```
aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT
```
Saída:
```
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.18,
"ConfigRuleInvokedTime": 1450314642.902,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-3a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.346,
"ConfigRuleInvokedTime": 1450314643.124,
"ComplianceType": "NON_COMPLIANT"
}
]
}
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-config-rule.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: Este exemplo obtém os resultados da avaliação da regra access-keys-rotated e retorna a saída agrupada por tipo de conformidade**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**Saída**:
```
Count Name Group
----- ---- -----
2 COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult}
5 NON_COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationRes...
```
**Exemplo 2: Este exemplo consulta os detalhes de conformidade da regra access-keys-rotated para recursos COMPATÍVEIS.**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**Saída**:
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém os resultados da avaliação da regra access-keys-rotated e retorna a saída agrupada por tipo de conformidade**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**Saída**:
```
Count Name Group
----- ---- -----
2 COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult}
5 NON_COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationRes...
```
**Exemplo 2: Este exemplo consulta os detalhes de conformidade da regra access-keys-rotated para recursos COMPATÍVEIS.**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**Saída**:
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `GetComplianceDetailsByResource` com uma CLI
Os exemplos de código a seguir mostram como usar o `GetComplianceDetailsByResource`.
------
#### [ CLI ]
**AWS CLI**
**Para obter os resultados da avaliação de um AWS recurso**
O comando a seguir retorna os resultados da avaliação de cada regra com a qual a instância do EC2 `i-1a2b3c4d` não está em conformidade:
```
aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT
```
Saída:
```
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.288,
"ConfigRuleInvokedTime": 1450314643.034,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "RequiredTagForEC2Instances"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
}
]
}
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-resource.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo avalia resultados para um determinado recurso.**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**Saída**:
```
Annotation :
ComplianceType : COMPLIANT
ConfigRuleInvokedTime : 8/25/2019 11:34:56 PM
EvaluationResultIdentifier : Amazon.ConfigService.Model.EvaluationResultIdentifier
ResultRecordedTime : 8/25/2019 11:34:56 PM
ResultToken :
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo avalia resultados para um determinado recurso.**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**Saída**:
```
Annotation :
ComplianceType : COMPLIANT
ConfigRuleInvokedTime : 8/25/2019 11:34:56 PM
EvaluationResultIdentifier : Amazon.ConfigService.Model.EvaluationResultIdentifier
ResultRecordedTime : 8/25/2019 11:34:56 PM
ResultToken :
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `GetComplianceSummaryByConfigRule` com uma CLI
Os exemplos de código a seguir mostram como usar o `GetComplianceSummaryByConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Para obter o resumo de conformidade de suas regras de AWS Config**
O seguinte comando retorna o número de regras que estão em conformidade e o número das que não estão:
```
aws configservice get-compliance-summary-by-config-rule
```
Na saída, o valor de cada atributo `CappedCount` indica quantas regras estão em conformidade ou não.
Saída:
```
{
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1452204131.493,
"CompliantResourceCount": {
"CappedCount": 2,
"CapExceeded": false
}
}
}
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-config-rule.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo retorna o número de regras do Config que não estão em conformidade.**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o número de regras do Config que não estão em conformidade.**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `GetComplianceSummaryByResourceType` com uma CLI
Os exemplos de código a seguir mostram como usar o `GetComplianceSummaryByResourceType`.
------
#### [ CLI ]
**AWS CLI**
**Para obter o resumo de conformidade para todos os tipos de recursos**
O comando a seguir retorna o número de AWS recursos que não estão em conformidade e o número que estão em conformidade:
```
aws configservice get-compliance-summary-by-resource-type
```
Na saída, o valor de cada atributo `CappedCount` indica quantos recursos estão em conformidade ou não.
Saída:
```
{
"ComplianceSummariesByResourceType": [
{
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 16,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1453237464.543,
"CompliantResourceCount": {
"CappedCount": 10,
"CapExceeded": false
}
}
}
]
}
```
**Para obter o resumo de conformidade para um tipo específico de recurso**
O seguinte comando retorna o número de instâncias do EC2 que não estão em conformidade e o número das que estão:
```
aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance
```
Na saída, o valor de cada atributo `CappedCount` indica quantos recursos estão em conformidade ou não.
Saída:
```
{
"ComplianceSummariesByResourceType": [
{
"ResourceType": "AWS::EC2::Instance",
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1452204923.518,
"CompliantResourceCount": {
"CappedCount": 7,
"CapExceeded": false
}
}
}
]
}
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByResourceType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-resource-type.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo retorna o número de recursos que estão em conformidade ou não e converte a saída em json.**
```
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json
{
"ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z",
"CompliantResourceCount": {
"CapExceeded": false,
"CappedCount": 2
},
"NonCompliantResourceCount": {
"CapExceeded": true,
"CappedCount": 100
}
}
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o número de recursos que estão em conformidade ou não e converte a saída em json.**
```
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json
{
"ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z",
"CompliantResourceCount": {
"CapExceeded": false,
"CappedCount": 2
},
"NonCompliantResourceCount": {
"CapExceeded": true,
"CappedCount": 100
}
}
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Use `PutConfigRule` com um AWS SDK ou CLI
Os exemplos de código a seguir mostram como usar o `PutConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Para adicionar uma regra de Config AWS gerenciada**
O comando a seguir fornece código JSON para adicionar uma regra Config AWS gerenciada:
```
aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json
```
`RequiredTagsForEC2Instances.json` é um arquivo JSON que contém a configuração da regra:
```
{
"ConfigRuleName": "RequiredTagsForEC2Instances",
"Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"Source": {
"Owner": "AWS",
"SourceIdentifier": "REQUIRED_TAGS"
},
"InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}"
}
```
Para o `ComplianceResourceTypes` atributo, esse código JSON limita o escopo a recursos do `AWS::EC2::Instance` tipo, então o AWS Config avaliará somente instâncias do EC2 em relação à regra. Como a regra é uma regra gerenciada, o atributo `Owner` é definido como `AWS` e o atributo `SourceIdentifier` é definido como o identificador da regra, `REQUIRED_TAGS`. Para o atributo `InputParameters`, as chaves de tag exigidas pela regra, `CostCenter` e `Owner` são especificados.
Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar a configuração da regra, execute o describe-config-rules comando e especifique o nome da regra.
**Como adicionar uma regra do Config gerenciada pelo cliente**
O seguinte comando fornece o código JSON para adicionar uma regra do Config gerenciada pelo cliente:
```
aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json
```
`InstanceTypesAreT2micro.json` é um arquivo JSON que contém a configuração da regra:
```
{
"ConfigRuleName": "InstanceTypesAreT2micro",
"Description": "Evaluates whether EC2 instances are the t2.micro type.",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"Source": {
"Owner": "CUSTOM_LAMBDA",
"SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck",
"SourceDetails": [
{
"EventSource": "aws.config",
"MessageType": "ConfigurationItemChangeNotification"
}
]
},
"InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}"
}
```
Para o `ComplianceResourceTypes` atributo, esse código JSON limita o escopo a recursos do `AWS::EC2::Instance` tipo, então o AWS Config avaliará somente instâncias do EC2 em relação à regra. Como essa regra é uma regra gerenciada pelo cliente, o `Owner` atributo é definido como`CUSTOM_LAMBDA`, e o `SourceIdentifier` atributo é definido como o ARN da função Lambda AWS . O `SourceDetails` objeto é obrigatório. Os parâmetros especificados para o `InputParameters` atributo são passados para a função AWS Lambda quando o AWS Config a invoca para avaliar os recursos em relação à regra.
Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar a configuração da regra, execute o describe-config-rules comando e especifique o nome da regra.
+ Para obter detalhes da API, consulte [PutConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-config-rule.html)em *Referência de AWS CLI Comandos*.
------
#### [ Python ]
**SDK para Python (Boto3)**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/config#code-examples).
```
class ConfigWrapper:
"""
Encapsulates AWS Config functions.
"""
def __init__(self, config_client):
"""
:param config_client: A Boto3 AWS Config client.
"""
self.config_client = config_client
def put_config_rule(self, rule_name):
"""
Sets a configuration rule that prohibits making Amazon S3 buckets publicly
readable.
:param rule_name: The name to give the rule.
"""
try:
self.config_client.put_config_rule(
ConfigRule={
"ConfigRuleName": rule_name,
"Description": "S3 Public Read Prohibited Bucket Rule",
"Scope": {
"ComplianceResourceTypes": [
"AWS::S3::Bucket",
],
},
"Source": {
"Owner": "AWS",
"SourceIdentifier": "S3_BUCKET_PUBLIC_READ_PROHIBITED",
},
"InputParameters": "{}",
"ConfigRuleState": "ACTIVE",
}
)
logger.info("Created configuration rule %s.", rule_name)
except ClientError:
logger.exception("Couldn't create configuration rule %s.", rule_name)
raise
```
+ Para obter detalhes da API, consulte a [PutConfigRule](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/PutConfigRule)Referência da API *AWS SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**SDK para SAP ABAP**
Tem mais sobre GitHub. Encontre o exemplo completo e saiba como configurar e executar no [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cfs#code-examples).
```
" Create a config rule for S3 bucket public read prohibition
lo_cfs->putconfigrule(
io_configrule = NEW /aws1/cl_cfsconfigrule(
iv_configrulename = iv_rule_name
iv_description = |S3 Public Read Prohibited Bucket Rule|
io_scope = NEW /aws1/cl_cfsscope(
it_complianceresourcetypes = VALUE /aws1/cl_cfscplncresrctypes_w=>tt_complianceresourcetypes(
( NEW /aws1/cl_cfscplncresrctypes_w( |AWS::S3::Bucket| ) )
)
)
io_source = NEW /aws1/cl_cfssource(
iv_owner = |AWS|
iv_sourceidentifier = |S3_BUCKET_PUBLIC_READ_PROHIBITED|
)
iv_inputparameters = '{}'
iv_configrulestate = |ACTIVE|
)
).
MESSAGE 'Created AWS Config rule.' TYPE 'I'.
```
+ Para obter detalhes da API, consulte a [PutConfigRule](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)referência da *API AWS SDK for SAP ABAP*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.
# Usar `PutDeliveryChannel` com uma CLI
Os exemplos de código a seguir mostram como usar o `PutDeliveryChannel`.
------
#### [ CLI ]
**AWS CLI**
**Para criar um canal de entrega**
O seguinte comando fornece as configurações do canal de entrega como código JSON:
```
aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json
```
O arquivo `deliveryChannel.json` especifica os atributos do canal de entrega:
```
{
"name": "default",
"s3BucketName": "config-bucket-123456789012",
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"configSnapshotDeliveryProperties": {
"deliveryFrequency": "Twelve_Hours"
}
}
```
Este exemplo define os seguintes atributos:
`name`: o nome do canal de entrega. Por padrão, o AWS Config atribui o nome `default` a um novo canal de entrega. Você não pode atualizar o nome do canal de entrega com o comando. `put-delivery-channel` Para ver as etapas para alterar o nome, consulte Como renomear o canal de entrega.`s3BucketName` - O nome do bucket do Amazon S3 para o qual o AWS Config entrega snapshots de configuração e arquivos de histórico de configuração. Se você especificar um bucket que pertença a outra AWS conta, esse bucket deve ter políticas que concedam permissões de acesso ao Config. AWS Para obter mais informações, consulte Permissões para o bucket do Amazon S3.
`snsTopicARN`- O Amazon Resource Name (ARN) do tópico do Amazon SNS para o qual o AWS Config envia notificações sobre alterações na configuração. Se você escolher um tópico de outra conta, o tópico deve ter políticas que concedam permissões de acesso ao Config. AWS Para obter mais informações, consulte o tópico Permissões para o Amazon SNS.
`configSnapshotDeliveryProperties`- Contém o `deliveryFrequency` atributo, que define com que frequência o AWS Config fornece instantâneos de configuração e com que frequência ele invoca avaliações para regras periódicas do Config.
Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar as configurações do seu canal de entrega, execute o describe-delivery-channels comando.
+ Para obter detalhes da API, consulte [PutDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-delivery-channel.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: este exemplo altera a propriedade deliveryFrequency de um canal de entrega existente.**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ Para obter detalhes da API, consulte [PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo altera a propriedade deliveryFrequency de um canal de entrega existente.**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ Para obter detalhes da API, consulte [PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
Para obter uma lista completa dos guias do desenvolvedor do AWS SDK e exemplos de código, consulte[Usando AWS Config com um AWS SDK](sdk-general-information-section.md). Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.