pub struct Client { /* private fields */ }
Expand description
Client for AWS Config
Client for invoking operations on AWS Config. Each operation on AWS Config is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_config::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_config::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateResourceTypes
operation has
a Client::associate_resource_types
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_resource_types()
.configuration_recorder_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn associate_resource_types(&self) -> AssociateResourceTypesFluentBuilder
pub fn associate_resource_types(&self) -> AssociateResourceTypesFluentBuilder
Constructs a fluent builder for the AssociateResourceTypes
operation.
- The fluent builder is configurable:
configuration_recorder_arn(impl Into<String>)
/set_configuration_recorder_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the specified configuration recorder.
resource_types(ResourceType)
/set_resource_types(Option<Vec::<ResourceType>>)
:
required: trueThe list of resource types you want to add to the recording group of the specified configuration recorder.
- On success, responds with
AssociateResourceTypesOutput
with field(s):configuration_recorder(Option<ConfigurationRecorder>)
:Records configuration changes to the resource types in scope.
For more information about the configuration recorder, see Working with the Configuration Recorder in the Config Developer Guide.
- On failure, responds with
SdkError<AssociateResourceTypesError>
Source§impl Client
impl Client
Sourcepub fn batch_get_aggregate_resource_config(
&self,
) -> BatchGetAggregateResourceConfigFluentBuilder
pub fn batch_get_aggregate_resource_config( &self, ) -> BatchGetAggregateResourceConfigFluentBuilder
Constructs a fluent builder for the BatchGetAggregateResourceConfig
operation.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
resource_identifiers(AggregateResourceIdentifier)
/set_resource_identifiers(Option<Vec::<AggregateResourceIdentifier>>)
:
required: trueA list of aggregate ResourceIdentifiers objects.
- On success, responds with
BatchGetAggregateResourceConfigOutput
with field(s):base_configuration_items(Option<Vec::<BaseConfigurationItem>>)
:A list that contains the current configuration of one or more resources.
unprocessed_resource_identifiers(Option<Vec::<AggregateResourceIdentifier>>)
:A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.
- On failure, responds with
SdkError<BatchGetAggregateResourceConfigError>
Source§impl Client
impl Client
Sourcepub fn batch_get_resource_config(&self) -> BatchGetResourceConfigFluentBuilder
pub fn batch_get_resource_config(&self) -> BatchGetResourceConfigFluentBuilder
Constructs a fluent builder for the BatchGetResourceConfig
operation.
- The fluent builder is configurable:
resource_keys(ResourceKey)
/set_resource_keys(Option<Vec::<ResourceKey>>)
:
required: trueA list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
- On success, responds with
BatchGetResourceConfigOutput
with field(s):base_configuration_items(Option<Vec::<BaseConfigurationItem>>)
:A list that contains the current configuration of one or more resources.
unprocessed_resource_keys(Option<Vec::<ResourceKey>>)
:A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.
- On failure, responds with
SdkError<BatchGetResourceConfigError>
Source§impl Client
impl Client
Constructs a fluent builder for the DeleteAggregationAuthorization
operation.
- The fluent builder is configurable:
authorized_account_id(impl Into<String>)
/set_authorized_account_id(Option<String>)
:
required: trueThe 12-digit account ID of the account authorized to aggregate data.
authorized_aws_region(impl Into<String>)
/set_authorized_aws_region(Option<String>)
:
required: trueThe region authorized to collect aggregated data.
- On success, responds with
DeleteAggregationAuthorizationOutput
- On failure, responds with
SdkError<DeleteAggregationAuthorizationError>
Source§impl Client
impl Client
Sourcepub fn delete_config_rule(&self) -> DeleteConfigRuleFluentBuilder
pub fn delete_config_rule(&self) -> DeleteConfigRuleFluentBuilder
Constructs a fluent builder for the DeleteConfigRule
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule that you want to delete.
- On success, responds with
DeleteConfigRuleOutput
- On failure, responds with
SdkError<DeleteConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_aggregator(
&self,
) -> DeleteConfigurationAggregatorFluentBuilder
pub fn delete_configuration_aggregator( &self, ) -> DeleteConfigurationAggregatorFluentBuilder
Constructs a fluent builder for the DeleteConfigurationAggregator
operation.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
- On success, responds with
DeleteConfigurationAggregatorOutput
- On failure, responds with
SdkError<DeleteConfigurationAggregatorError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_recorder(
&self,
) -> DeleteConfigurationRecorderFluentBuilder
pub fn delete_configuration_recorder( &self, ) -> DeleteConfigurationRecorderFluentBuilder
Constructs a fluent builder for the DeleteConfigurationRecorder
operation.
- The fluent builder is configurable:
configuration_recorder_name(impl Into<String>)
/set_configuration_recorder_name(Option<String>)
:
required: trueThe name of the customer managed configuration recorder that you want to delete. You can retrieve the name of your configuration recorders by using the DescribeConfigurationRecorders operation.
- On success, responds with
DeleteConfigurationRecorderOutput
- On failure, responds with
SdkError<DeleteConfigurationRecorderError>
Source§impl Client
impl Client
Sourcepub fn delete_conformance_pack(&self) -> DeleteConformancePackFluentBuilder
pub fn delete_conformance_pack(&self) -> DeleteConformancePackFluentBuilder
Constructs a fluent builder for the DeleteConformancePack
operation.
- The fluent builder is configurable:
conformance_pack_name(impl Into<String>)
/set_conformance_pack_name(Option<String>)
:
required: trueName of the conformance pack you want to delete.
- On success, responds with
DeleteConformancePackOutput
- On failure, responds with
SdkError<DeleteConformancePackError>
Source§impl Client
impl Client
Sourcepub fn delete_delivery_channel(&self) -> DeleteDeliveryChannelFluentBuilder
pub fn delete_delivery_channel(&self) -> DeleteDeliveryChannelFluentBuilder
Constructs a fluent builder for the DeleteDeliveryChannel
operation.
- The fluent builder is configurable:
delivery_channel_name(impl Into<String>)
/set_delivery_channel_name(Option<String>)
:
required: trueThe name of the delivery channel that you want to delete.
- On success, responds with
DeleteDeliveryChannelOutput
- On failure, responds with
SdkError<DeleteDeliveryChannelError>
Source§impl Client
impl Client
Sourcepub fn delete_evaluation_results(&self) -> DeleteEvaluationResultsFluentBuilder
pub fn delete_evaluation_results(&self) -> DeleteEvaluationResultsFluentBuilder
Constructs a fluent builder for the DeleteEvaluationResults
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule for which you want to delete the evaluation results.
- On success, responds with
DeleteEvaluationResultsOutput
- On failure, responds with
SdkError<DeleteEvaluationResultsError>
Source§impl Client
impl Client
Sourcepub fn delete_organization_config_rule(
&self,
) -> DeleteOrganizationConfigRuleFluentBuilder
pub fn delete_organization_config_rule( &self, ) -> DeleteOrganizationConfigRuleFluentBuilder
Constructs a fluent builder for the DeleteOrganizationConfigRule
operation.
- The fluent builder is configurable:
organization_config_rule_name(impl Into<String>)
/set_organization_config_rule_name(Option<String>)
:
required: trueThe name of organization Config rule that you want to delete.
- On success, responds with
DeleteOrganizationConfigRuleOutput
- On failure, responds with
SdkError<DeleteOrganizationConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_organization_conformance_pack(
&self,
) -> DeleteOrganizationConformancePackFluentBuilder
pub fn delete_organization_conformance_pack( &self, ) -> DeleteOrganizationConformancePackFluentBuilder
Constructs a fluent builder for the DeleteOrganizationConformancePack
operation.
- The fluent builder is configurable:
organization_conformance_pack_name(impl Into<String>)
/set_organization_conformance_pack_name(Option<String>)
:
required: trueThe name of organization conformance pack that you want to delete.
- On success, responds with
DeleteOrganizationConformancePackOutput
- On failure, responds with
SdkError<DeleteOrganizationConformancePackError>
Source§impl Client
impl Client
Sourcepub fn delete_pending_aggregation_request(
&self,
) -> DeletePendingAggregationRequestFluentBuilder
pub fn delete_pending_aggregation_request( &self, ) -> DeletePendingAggregationRequestFluentBuilder
Constructs a fluent builder for the DeletePendingAggregationRequest
operation.
- The fluent builder is configurable:
requester_account_id(impl Into<String>)
/set_requester_account_id(Option<String>)
:
required: trueThe 12-digit account ID of the account requesting to aggregate data.
requester_aws_region(impl Into<String>)
/set_requester_aws_region(Option<String>)
:
required: trueThe region requesting to aggregate data.
- On success, responds with
DeletePendingAggregationRequestOutput
- On failure, responds with
SdkError<DeletePendingAggregationRequestError>
Source§impl Client
impl Client
Sourcepub fn delete_remediation_configuration(
&self,
) -> DeleteRemediationConfigurationFluentBuilder
pub fn delete_remediation_configuration( &self, ) -> DeleteRemediationConfigurationFluentBuilder
Constructs a fluent builder for the DeleteRemediationConfiguration
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule for which you want to delete remediation configuration.
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: falseThe type of a resource.
- On success, responds with
DeleteRemediationConfigurationOutput
- On failure, responds with
SdkError<DeleteRemediationConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_remediation_exceptions(
&self,
) -> DeleteRemediationExceptionsFluentBuilder
pub fn delete_remediation_exceptions( &self, ) -> DeleteRemediationExceptionsFluentBuilder
Constructs a fluent builder for the DeleteRemediationExceptions
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule for which you want to delete remediation exception configuration.
resource_keys(RemediationExceptionResourceKey)
/set_resource_keys(Option<Vec::<RemediationExceptionResourceKey>>)
:
required: trueAn exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
- On success, responds with
DeleteRemediationExceptionsOutput
with field(s):failed_batches(Option<Vec::<FailedDeleteRemediationExceptionsBatch>>)
:Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
- On failure, responds with
SdkError<DeleteRemediationExceptionsError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_config(&self) -> DeleteResourceConfigFluentBuilder
pub fn delete_resource_config(&self) -> DeleteResourceConfigFluentBuilder
Constructs a fluent builder for the DeleteResourceConfig
operation.
- The fluent builder is configurable:
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: trueThe type of the resource.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueUnique identifier of the resource.
- On success, responds with
DeleteResourceConfigOutput
- On failure, responds with
SdkError<DeleteResourceConfigError>
Source§impl Client
impl Client
Sourcepub fn delete_retention_configuration(
&self,
) -> DeleteRetentionConfigurationFluentBuilder
pub fn delete_retention_configuration( &self, ) -> DeleteRetentionConfigurationFluentBuilder
Constructs a fluent builder for the DeleteRetentionConfiguration
operation.
- The fluent builder is configurable:
retention_configuration_name(impl Into<String>)
/set_retention_configuration_name(Option<String>)
:
required: trueThe name of the retention configuration to delete.
- On success, responds with
DeleteRetentionConfigurationOutput
- On failure, responds with
SdkError<DeleteRetentionConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_service_linked_configuration_recorder(
&self,
) -> DeleteServiceLinkedConfigurationRecorderFluentBuilder
pub fn delete_service_linked_configuration_recorder( &self, ) -> DeleteServiceLinkedConfigurationRecorderFluentBuilder
Constructs a fluent builder for the DeleteServiceLinkedConfigurationRecorder
operation.
- The fluent builder is configurable:
service_principal(impl Into<String>)
/set_service_principal(Option<String>)
:
required: trueThe service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to delete.
- On success, responds with
DeleteServiceLinkedConfigurationRecorderOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) of the specified configuration recorder.
name(String)
:The name of the specified configuration recorder.
- On failure, responds with
SdkError<DeleteServiceLinkedConfigurationRecorderError>
Source§impl Client
impl Client
Sourcepub fn delete_stored_query(&self) -> DeleteStoredQueryFluentBuilder
pub fn delete_stored_query(&self) -> DeleteStoredQueryFluentBuilder
Constructs a fluent builder for the DeleteStoredQuery
operation.
- The fluent builder is configurable:
query_name(impl Into<String>)
/set_query_name(Option<String>)
:
required: trueThe name of the query that you want to delete.
- On success, responds with
DeleteStoredQueryOutput
- On failure, responds with
SdkError<DeleteStoredQueryError>
Source§impl Client
impl Client
Sourcepub fn deliver_config_snapshot(&self) -> DeliverConfigSnapshotFluentBuilder
pub fn deliver_config_snapshot(&self) -> DeliverConfigSnapshotFluentBuilder
Constructs a fluent builder for the DeliverConfigSnapshot
operation.
- The fluent builder is configurable:
delivery_channel_name(impl Into<String>)
/set_delivery_channel_name(Option<String>)
:
required: trueThe name of the delivery channel through which the snapshot is delivered.
- On success, responds with
DeliverConfigSnapshotOutput
with field(s):config_snapshot_id(Option<String>)
:The ID of the snapshot that is being created.
- On failure, responds with
SdkError<DeliverConfigSnapshotError>
Source§impl Client
impl Client
Sourcepub fn describe_aggregate_compliance_by_config_rules(
&self,
) -> DescribeAggregateComplianceByConfigRulesFluentBuilder
pub fn describe_aggregate_compliance_by_config_rules( &self, ) -> DescribeAggregateComplianceByConfigRulesFluentBuilder
Constructs a fluent builder for the DescribeAggregateComplianceByConfigRules
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
filters(ConfigRuleComplianceFilters)
/set_filters(Option<ConfigRuleComplianceFilters>)
:
required: falseFilters the results by ConfigRuleComplianceFilters object.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeAggregateComplianceByConfigRulesOutput
with field(s):aggregate_compliance_by_config_rules(Option<Vec::<AggregateComplianceByConfigRule>>)
:Returns a list of AggregateComplianceByConfigRule object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeAggregateComplianceByConfigRulesError>
Source§impl Client
impl Client
Sourcepub fn describe_aggregate_compliance_by_conformance_packs(
&self,
) -> DescribeAggregateComplianceByConformancePacksFluentBuilder
pub fn describe_aggregate_compliance_by_conformance_packs( &self, ) -> DescribeAggregateComplianceByConformancePacksFluentBuilder
Constructs a fluent builder for the DescribeAggregateComplianceByConformancePacks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
filters(AggregateConformancePackComplianceFilters)
/set_filters(Option<AggregateConformancePackComplianceFilters>)
:
required: falseFilters the result by
AggregateConformancePackComplianceFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeAggregateComplianceByConformancePacksOutput
with field(s):aggregate_compliance_by_conformance_packs(Option<Vec::<AggregateComplianceByConformancePack>>)
:Returns the
AggregateComplianceByConformancePack
object.next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeAggregateComplianceByConformancePacksError>
Source§impl Client
impl Client
Constructs a fluent builder for the DescribeAggregationAuthorizations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeAggregationAuthorizationsOutput
with field(s):aggregation_authorizations(Option<Vec::<AggregationAuthorization>>)
:Returns a list of authorizations granted to various aggregator accounts and regions.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeAggregationAuthorizationsError>
Source§impl Client
impl Client
Sourcepub fn describe_compliance_by_config_rule(
&self,
) -> DescribeComplianceByConfigRuleFluentBuilder
pub fn describe_compliance_by_config_rule( &self, ) -> DescribeComplianceByConfigRuleFluentBuilder
Constructs a fluent builder for the DescribeComplianceByConfigRule
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
config_rule_names(impl Into<String>)
/set_config_rule_names(Option<Vec::<String>>)
:
required: falseSpecify one or more Config rule names to filter the results by rule.
compliance_types(ComplianceType)
/set_compliance_types(Option<Vec::<ComplianceType>>)
:
required: falseFilters the results by compliance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeComplianceByConfigRuleOutput
with field(s):compliance_by_config_rules(Option<Vec::<ComplianceByConfigRule>>)
:Indicates whether each of the specified Config rules is compliant.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeComplianceByConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn describe_compliance_by_resource(
&self,
) -> DescribeComplianceByResourceFluentBuilder
pub fn describe_compliance_by_resource( &self, ) -> DescribeComplianceByResourceFluentBuilder
Constructs a fluent builder for the DescribeComplianceByResource
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: falseThe types of Amazon Web Services resources for which you want compliance information (for example,
AWS::EC2::Instance
). For this operation, you can specify that the resource type is an Amazon Web Services account by specifyingAWS::::Account
.resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: falseThe ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for
ResourceType
.compliance_types(ComplianceType)
/set_compliance_types(Option<Vec::<ComplianceType>>)
:
required: falseFilters the results by compliance.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeComplianceByResourceOutput
with field(s):compliance_by_resources(Option<Vec::<ComplianceByResource>>)
:Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeComplianceByResourceError>
Source§impl Client
impl Client
Sourcepub fn describe_config_rule_evaluation_status(
&self,
) -> DescribeConfigRuleEvaluationStatusFluentBuilder
pub fn describe_config_rule_evaluation_status( &self, ) -> DescribeConfigRuleEvaluationStatusFluentBuilder
Constructs a fluent builder for the DescribeConfigRuleEvaluationStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
config_rule_names(impl Into<String>)
/set_config_rule_names(Option<Vec::<String>>)
:
required: falseThe name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe number of rule evaluation results that you want returned.
This parameter is required if the rule limit for your account is more than the default of 1000 rules.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.
- On success, responds with
DescribeConfigRuleEvaluationStatusOutput
with field(s):config_rules_evaluation_status(Option<Vec::<ConfigRuleEvaluationStatus>>)
:Status information about your Config managed rules.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConfigRuleEvaluationStatusError>
Source§impl Client
impl Client
Sourcepub fn describe_config_rules(&self) -> DescribeConfigRulesFluentBuilder
pub fn describe_config_rules(&self) -> DescribeConfigRulesFluentBuilder
Constructs a fluent builder for the DescribeConfigRules
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
config_rule_names(impl Into<String>)
/set_config_rule_names(Option<Vec::<String>>)
:
required: falseThe names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.filters(DescribeConfigRulesFilters)
/set_filters(Option<DescribeConfigRulesFilters>)
:
required: falseReturns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
- On success, responds with
DescribeConfigRulesOutput
with field(s):config_rules(Option<Vec::<ConfigRule>>)
:The details about your Config rules.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConfigRulesError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_aggregator_sources_status(
&self,
) -> DescribeConfigurationAggregatorSourcesStatusFluentBuilder
pub fn describe_configuration_aggregator_sources_status( &self, ) -> DescribeConfigurationAggregatorSourcesStatusFluentBuilder
Constructs a fluent builder for the DescribeConfigurationAggregatorSourcesStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
update_status(AggregatedSourceStatusType)
/set_update_status(Option<Vec::<AggregatedSourceStatusType>>)
:
required: falseFilters the status type.
-
Valid value FAILED indicates errors while moving data.
-
Valid value SUCCEEDED indicates the data was successfully moved.
-
Valid value OUTDATED indicates the data is not the most recent.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.
- On success, responds with
DescribeConfigurationAggregatorSourcesStatusOutput
with field(s):aggregated_source_status_list(Option<Vec::<AggregatedSourceStatus>>)
:Returns an AggregatedSourceStatus object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConfigurationAggregatorSourcesStatusError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_aggregators(
&self,
) -> DescribeConfigurationAggregatorsFluentBuilder
pub fn describe_configuration_aggregators( &self, ) -> DescribeConfigurationAggregatorsFluentBuilder
Constructs a fluent builder for the DescribeConfigurationAggregators
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_names(impl Into<String>)
/set_configuration_aggregator_names(Option<Vec::<String>>)
:
required: falseThe name of the configuration aggregators.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.
- On success, responds with
DescribeConfigurationAggregatorsOutput
with field(s):configuration_aggregators(Option<Vec::<ConfigurationAggregator>>)
:Returns a ConfigurationAggregators object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConfigurationAggregatorsError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_recorder_status(
&self,
) -> DescribeConfigurationRecorderStatusFluentBuilder
pub fn describe_configuration_recorder_status( &self, ) -> DescribeConfigurationRecorderStatusFluentBuilder
Constructs a fluent builder for the DescribeConfigurationRecorderStatus
operation.
- The fluent builder is configurable:
configuration_recorder_names(impl Into<String>)
/set_configuration_recorder_names(Option<Vec::<String>>)
:
required: falseThe name of the configuration recorder. If the name is not specified, the opertation returns the status for the customer managed configuration recorder configured for the account, if applicable.
When making a request to this operation, you can only specify one configuration recorder.
service_principal(impl Into<String>)
/set_service_principal(Option<String>)
:
required: falseFor service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder.
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the configuration recorder that you want to specify.
- On success, responds with
DescribeConfigurationRecorderStatusOutput
with field(s):configuration_recorders_status(Option<Vec::<ConfigurationRecorderStatus>>)
:A list that contains status of the specified recorders.
- On failure, responds with
SdkError<DescribeConfigurationRecorderStatusError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_recorders(
&self,
) -> DescribeConfigurationRecordersFluentBuilder
pub fn describe_configuration_recorders( &self, ) -> DescribeConfigurationRecordersFluentBuilder
Constructs a fluent builder for the DescribeConfigurationRecorders
operation.
- The fluent builder is configurable:
configuration_recorder_names(impl Into<String>)
/set_configuration_recorder_names(Option<Vec::<String>>)
:
required: falseA list of names of the configuration recorders that you want to specify.
service_principal(impl Into<String>)
/set_service_principal(Option<String>)
:
required: falseFor service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder.
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the configuration recorder that you want to specify.
- On success, responds with
DescribeConfigurationRecordersOutput
with field(s):configuration_recorders(Option<Vec::<ConfigurationRecorder>>)
:A list that contains the descriptions of the specified configuration recorders.
- On failure, responds with
SdkError<DescribeConfigurationRecordersError>
Source§impl Client
impl Client
Sourcepub fn describe_conformance_pack_compliance(
&self,
) -> DescribeConformancePackComplianceFluentBuilder
pub fn describe_conformance_pack_compliance( &self, ) -> DescribeConformancePackComplianceFluentBuilder
Constructs a fluent builder for the DescribeConformancePackCompliance
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
conformance_pack_name(impl Into<String>)
/set_conformance_pack_name(Option<String>)
:
required: trueName of the conformance pack.
filters(ConformancePackComplianceFilters)
/set_filters(Option<ConformancePackComplianceFilters>)
:
required: falseA
ConformancePackComplianceFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of Config rules within a conformance pack are returned on each page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
DescribeConformancePackComplianceOutput
with field(s):conformance_pack_name(String)
:Name of the conformance pack.
conformance_pack_rule_compliance_list(Vec::<ConformancePackRuleCompliance>)
:Returns a list of
ConformancePackRuleCompliance
objects.next_token(Option<String>)
:The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConformancePackComplianceError>
Source§impl Client
impl Client
Sourcepub fn describe_conformance_pack_status(
&self,
) -> DescribeConformancePackStatusFluentBuilder
pub fn describe_conformance_pack_status( &self, ) -> DescribeConformancePackStatusFluentBuilder
Constructs a fluent builder for the DescribeConformancePackStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
conformance_pack_names(impl Into<String>)
/set_conformance_pack_names(Option<Vec::<String>>)
:
required: falseComma-separated list of conformance pack names.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of conformance packs status returned on each page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
DescribeConformancePackStatusOutput
with field(s):conformance_pack_status_details(Option<Vec::<ConformancePackStatusDetail>>)
:A list of
ConformancePackStatusDetail
objects.next_token(Option<String>)
:The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConformancePackStatusError>
Source§impl Client
impl Client
Sourcepub fn describe_conformance_packs(
&self,
) -> DescribeConformancePacksFluentBuilder
pub fn describe_conformance_packs( &self, ) -> DescribeConformancePacksFluentBuilder
Constructs a fluent builder for the DescribeConformancePacks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
conformance_pack_names(impl Into<String>)
/set_conformance_pack_names(Option<Vec::<String>>)
:
required: falseComma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of conformance packs returned on each page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
DescribeConformancePacksOutput
with field(s):conformance_pack_details(Option<Vec::<ConformancePackDetail>>)
:Returns a list of
ConformancePackDetail
objects.next_token(Option<String>)
:The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeConformancePacksError>
Source§impl Client
impl Client
Sourcepub fn describe_delivery_channel_status(
&self,
) -> DescribeDeliveryChannelStatusFluentBuilder
pub fn describe_delivery_channel_status( &self, ) -> DescribeDeliveryChannelStatusFluentBuilder
Constructs a fluent builder for the DescribeDeliveryChannelStatus
operation.
- The fluent builder is configurable:
delivery_channel_names(impl Into<String>)
/set_delivery_channel_names(Option<Vec::<String>>)
:
required: falseA list of delivery channel names.
- On success, responds with
DescribeDeliveryChannelStatusOutput
with field(s):delivery_channels_status(Option<Vec::<DeliveryChannelStatus>>)
:A list that contains the status of a specified delivery channel.
- On failure, responds with
SdkError<DescribeDeliveryChannelStatusError>
Source§impl Client
impl Client
Sourcepub fn describe_delivery_channels(
&self,
) -> DescribeDeliveryChannelsFluentBuilder
pub fn describe_delivery_channels( &self, ) -> DescribeDeliveryChannelsFluentBuilder
Constructs a fluent builder for the DescribeDeliveryChannels
operation.
- The fluent builder is configurable:
delivery_channel_names(impl Into<String>)
/set_delivery_channel_names(Option<Vec::<String>>)
:
required: falseA list of delivery channel names.
- On success, responds with
DescribeDeliveryChannelsOutput
with field(s):delivery_channels(Option<Vec::<DeliveryChannel>>)
:A list that contains the descriptions of the specified delivery channel.
- On failure, responds with
SdkError<DescribeDeliveryChannelsError>
Source§impl Client
impl Client
Sourcepub fn describe_organization_config_rule_statuses(
&self,
) -> DescribeOrganizationConfigRuleStatusesFluentBuilder
pub fn describe_organization_config_rule_statuses( &self, ) -> DescribeOrganizationConfigRuleStatusesFluentBuilder
Constructs a fluent builder for the DescribeOrganizationConfigRuleStatuses
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_config_rule_names(impl Into<String>)
/set_organization_config_rule_names(Option<Vec::<String>>)
:
required: falseThe names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of
OrganizationConfigRuleStatuses
returned on each page. If you do no specify a number, Config uses the default. The default is 100.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeOrganizationConfigRuleStatusesOutput
with field(s):organization_config_rule_statuses(Option<Vec::<OrganizationConfigRuleStatus>>)
:A list of
OrganizationConfigRuleStatus
objects.next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeOrganizationConfigRuleStatusesError>
Source§impl Client
impl Client
Sourcepub fn describe_organization_config_rules(
&self,
) -> DescribeOrganizationConfigRulesFluentBuilder
pub fn describe_organization_config_rules( &self, ) -> DescribeOrganizationConfigRulesFluentBuilder
Constructs a fluent builder for the DescribeOrganizationConfigRules
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_config_rule_names(impl Into<String>)
/set_organization_config_rule_names(Option<Vec::<String>>)
:
required: falseThe names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeOrganizationConfigRulesOutput
with field(s):organization_config_rules(Option<Vec::<OrganizationConfigRule>>)
:Returns a list of
OrganizationConfigRule
objects.next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeOrganizationConfigRulesError>
Source§impl Client
impl Client
Sourcepub fn describe_organization_conformance_pack_statuses(
&self,
) -> DescribeOrganizationConformancePackStatusesFluentBuilder
pub fn describe_organization_conformance_pack_statuses( &self, ) -> DescribeOrganizationConformancePackStatusesFluentBuilder
Constructs a fluent builder for the DescribeOrganizationConformancePackStatuses
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_conformance_pack_names(impl Into<String>)
/set_organization_conformance_pack_names(Option<Vec::<String>>)
:
required: falseThe names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeOrganizationConformancePackStatusesOutput
with field(s):organization_conformance_pack_statuses(Option<Vec::<OrganizationConformancePackStatus>>)
:A list of
OrganizationConformancePackStatus
objects.next_token(Option<String>)
:The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeOrganizationConformancePackStatusesError>
Source§impl Client
impl Client
Sourcepub fn describe_organization_conformance_packs(
&self,
) -> DescribeOrganizationConformancePacksFluentBuilder
pub fn describe_organization_conformance_packs( &self, ) -> DescribeOrganizationConformancePacksFluentBuilder
Constructs a fluent builder for the DescribeOrganizationConformancePacks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_conformance_pack_names(impl Into<String>)
/set_organization_conformance_pack_names(Option<Vec::<String>>)
:
required: falseThe name that you assign to an organization conformance pack.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeOrganizationConformancePacksOutput
with field(s):organization_conformance_packs(Option<Vec::<OrganizationConformancePack>>)
:Returns a list of OrganizationConformancePacks objects.
next_token(Option<String>)
:The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeOrganizationConformancePacksError>
Source§impl Client
impl Client
Sourcepub fn describe_pending_aggregation_requests(
&self,
) -> DescribePendingAggregationRequestsFluentBuilder
pub fn describe_pending_aggregation_requests( &self, ) -> DescribePendingAggregationRequestsFluentBuilder
Constructs a fluent builder for the DescribePendingAggregationRequests
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribePendingAggregationRequestsOutput
with field(s):pending_aggregation_requests(Option<Vec::<PendingAggregationRequest>>)
:Returns a PendingAggregationRequests object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribePendingAggregationRequestsError>
Source§impl Client
impl Client
Sourcepub fn describe_remediation_configurations(
&self,
) -> DescribeRemediationConfigurationsFluentBuilder
pub fn describe_remediation_configurations( &self, ) -> DescribeRemediationConfigurationsFluentBuilder
Constructs a fluent builder for the DescribeRemediationConfigurations
operation.
- The fluent builder is configurable:
config_rule_names(impl Into<String>)
/set_config_rule_names(Option<Vec::<String>>)
:
required: trueA list of Config rule names of remediation configurations for which you want details.
- On success, responds with
DescribeRemediationConfigurationsOutput
with field(s):remediation_configurations(Option<Vec::<RemediationConfiguration>>)
:Returns a remediation configuration object.
- On failure, responds with
SdkError<DescribeRemediationConfigurationsError>
Source§impl Client
impl Client
Sourcepub fn describe_remediation_exceptions(
&self,
) -> DescribeRemediationExceptionsFluentBuilder
pub fn describe_remediation_exceptions( &self, ) -> DescribeRemediationExceptionsFluentBuilder
Constructs a fluent builder for the DescribeRemediationExceptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule.
resource_keys(RemediationExceptionResourceKey)
/set_resource_keys(Option<Vec::<RemediationExceptionResourceKey>>)
:
required: falseAn exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
DescribeRemediationExceptionsOutput
with field(s):remediation_exceptions(Option<Vec::<RemediationException>>)
:Returns a list of remediation exception objects.
next_token(Option<String>)
:The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeRemediationExceptionsError>
Source§impl Client
impl Client
Sourcepub fn describe_remediation_execution_status(
&self,
) -> DescribeRemediationExecutionStatusFluentBuilder
pub fn describe_remediation_execution_status( &self, ) -> DescribeRemediationExecutionStatusFluentBuilder
Constructs a fluent builder for the DescribeRemediationExecutionStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule.
resource_keys(ResourceKey)
/set_resource_keys(Option<Vec::<ResourceKey>>)
:
required: falseA list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeRemediationExecutionStatusOutput
with field(s):remediation_execution_statuses(Option<Vec::<RemediationExecutionStatus>>)
:Returns a list of remediation execution statuses objects.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeRemediationExecutionStatusError>
Source§impl Client
impl Client
Sourcepub fn describe_retention_configurations(
&self,
) -> DescribeRetentionConfigurationsFluentBuilder
pub fn describe_retention_configurations( &self, ) -> DescribeRetentionConfigurationsFluentBuilder
Constructs a fluent builder for the DescribeRetentionConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
retention_configuration_names(impl Into<String>)
/set_retention_configuration_names(Option<Vec::<String>>)
:
required: falseA list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
DescribeRetentionConfigurationsOutput
with field(s):retention_configurations(Option<Vec::<RetentionConfiguration>>)
:Returns a retention configuration object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<DescribeRetentionConfigurationsError>
Source§impl Client
impl Client
Sourcepub fn disassociate_resource_types(
&self,
) -> DisassociateResourceTypesFluentBuilder
pub fn disassociate_resource_types( &self, ) -> DisassociateResourceTypesFluentBuilder
Constructs a fluent builder for the DisassociateResourceTypes
operation.
- The fluent builder is configurable:
configuration_recorder_arn(impl Into<String>)
/set_configuration_recorder_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the specified configuration recorder.
resource_types(ResourceType)
/set_resource_types(Option<Vec::<ResourceType>>)
:
required: trueThe list of resource types you want to remove from the recording group of the specified configuration recorder.
- On success, responds with
DisassociateResourceTypesOutput
with field(s):configuration_recorder(Option<ConfigurationRecorder>)
:Records configuration changes to the resource types in scope.
For more information about the configuration recorder, see Working with the Configuration Recorder in the Config Developer Guide.
- On failure, responds with
SdkError<DisassociateResourceTypesError>
Source§impl Client
impl Client
Sourcepub fn get_aggregate_compliance_details_by_config_rule(
&self,
) -> GetAggregateComplianceDetailsByConfigRuleFluentBuilder
pub fn get_aggregate_compliance_details_by_config_rule( &self, ) -> GetAggregateComplianceDetailsByConfigRuleFluentBuilder
Constructs a fluent builder for the GetAggregateComplianceDetailsByConfigRule
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule for which you want compliance information.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: trueThe 12-digit account ID of the source account.
aws_region(impl Into<String>)
/set_aws_region(Option<String>)
:
required: trueThe source region from where the data is aggregated.
compliance_type(ComplianceType)
/set_compliance_type(Option<ComplianceType>)
:
required: falseThe resource compliance status.
For the
GetAggregateComplianceDetailsByConfigRuleRequest
data type, Config supports only theCOMPLIANT
andNON_COMPLIANT
. Config does not support theNOT_APPLICABLE
andINSUFFICIENT_DATA
values.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetAggregateComplianceDetailsByConfigRuleOutput
with field(s):aggregate_evaluation_results(Option<Vec::<AggregateEvaluationResult>>)
:Returns an AggregateEvaluationResults object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetAggregateComplianceDetailsByConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn get_aggregate_config_rule_compliance_summary(
&self,
) -> GetAggregateConfigRuleComplianceSummaryFluentBuilder
pub fn get_aggregate_config_rule_compliance_summary( &self, ) -> GetAggregateConfigRuleComplianceSummaryFluentBuilder
Constructs a fluent builder for the GetAggregateConfigRuleComplianceSummary
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
filters(ConfigRuleComplianceSummaryFilters)
/set_filters(Option<ConfigRuleComplianceSummaryFilters>)
:
required: falseFilters the results based on the ConfigRuleComplianceSummaryFilters object.
group_by_key(ConfigRuleComplianceSummaryGroupKey)
/set_group_by_key(Option<ConfigRuleComplianceSummaryGroupKey>)
:
required: falseGroups the result based on ACCOUNT_ID or AWS_REGION.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetAggregateConfigRuleComplianceSummaryOutput
with field(s):group_by_key(Option<String>)
:Groups the result based on ACCOUNT_ID or AWS_REGION.
aggregate_compliance_counts(Option<Vec::<AggregateComplianceCount>>)
:Returns a list of AggregateComplianceCounts object.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetAggregateConfigRuleComplianceSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_aggregate_conformance_pack_compliance_summary(
&self,
) -> GetAggregateConformancePackComplianceSummaryFluentBuilder
pub fn get_aggregate_conformance_pack_compliance_summary( &self, ) -> GetAggregateConformancePackComplianceSummaryFluentBuilder
Constructs a fluent builder for the GetAggregateConformancePackComplianceSummary
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
filters(AggregateConformancePackComplianceSummaryFilters)
/set_filters(Option<AggregateConformancePackComplianceSummaryFilters>)
:
required: falseFilters the results based on the
AggregateConformancePackComplianceSummaryFilters
object.group_by_key(AggregateConformancePackComplianceSummaryGroupKey)
/set_group_by_key(Option<AggregateConformancePackComplianceSummaryGroupKey>)
:
required: falseGroups the result based on Amazon Web Services account ID or Amazon Web Services Region.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetAggregateConformancePackComplianceSummaryOutput
with field(s):aggregate_conformance_pack_compliance_summaries(Option<Vec::<AggregateConformancePackComplianceSummary>>)
:Returns a list of
AggregateConformancePackComplianceSummary
object.group_by_key(Option<String>)
:Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetAggregateConformancePackComplianceSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_aggregate_discovered_resource_counts(
&self,
) -> GetAggregateDiscoveredResourceCountsFluentBuilder
pub fn get_aggregate_discovered_resource_counts( &self, ) -> GetAggregateDiscoveredResourceCountsFluentBuilder
Constructs a fluent builder for the GetAggregateDiscoveredResourceCounts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
filters(ResourceCountFilters)
/set_filters(Option<ResourceCountFilters>)
:
required: falseFilters the results based on the
ResourceCountFilters
object.group_by_key(ResourceCountGroupKey)
/set_group_by_key(Option<ResourceCountGroupKey>)
:
required: falseThe key to group the resource counts.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of
GroupedResourceCount
objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetAggregateDiscoveredResourceCountsOutput
with field(s):total_discovered_resources(i64)
:The total number of resources that are present in an aggregator with the filters that you provide.
group_by_key(Option<String>)
:The key passed into the request object. If
GroupByKey
is not provided, the result will be empty.grouped_resource_counts(Option<Vec::<GroupedResourceCount>>)
:Returns a list of GroupedResourceCount objects.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetAggregateDiscoveredResourceCountsError>
Source§impl Client
impl Client
Sourcepub fn get_aggregate_resource_config(
&self,
) -> GetAggregateResourceConfigFluentBuilder
pub fn get_aggregate_resource_config( &self, ) -> GetAggregateResourceConfigFluentBuilder
Constructs a fluent builder for the GetAggregateResourceConfig
operation.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
resource_identifier(AggregateResourceIdentifier)
/set_resource_identifier(Option<AggregateResourceIdentifier>)
:
required: trueAn object that identifies aggregate resource.
- On success, responds with
GetAggregateResourceConfigOutput
with field(s):configuration_item(Option<ConfigurationItem>)
:Returns a
ConfigurationItem
object.
- On failure, responds with
SdkError<GetAggregateResourceConfigError>
Source§impl Client
impl Client
Sourcepub fn get_compliance_details_by_config_rule(
&self,
) -> GetComplianceDetailsByConfigRuleFluentBuilder
pub fn get_compliance_details_by_config_rule( &self, ) -> GetComplianceDetailsByConfigRuleFluentBuilder
Constructs a fluent builder for the GetComplianceDetailsByConfigRule
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule for which you want compliance information.
compliance_types(ComplianceType)
/set_compliance_types(Option<Vec::<ComplianceType>>)
:
required: falseFilters the results by compliance.
INSUFFICIENT_DATA
is a validComplianceType
that is returned when an Config rule cannot be evaluated. However,INSUFFICIENT_DATA
cannot be used as aComplianceType
for filtering results.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetComplianceDetailsByConfigRuleOutput
with field(s):evaluation_results(Option<Vec::<EvaluationResult>>)
:Indicates whether the Amazon Web Services resource complies with the specified Config rule.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetComplianceDetailsByConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn get_compliance_details_by_resource(
&self,
) -> GetComplianceDetailsByResourceFluentBuilder
pub fn get_compliance_details_by_resource( &self, ) -> GetComplianceDetailsByResourceFluentBuilder
Constructs a fluent builder for the GetComplianceDetailsByResource
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: falseThe type of the Amazon Web Services resource for which you want compliance information.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: falseThe ID of the Amazon Web Services resource for which you want compliance information.
compliance_types(ComplianceType)
/set_compliance_types(Option<Vec::<ComplianceType>>)
:
required: falseFilters the results by compliance.
INSUFFICIENT_DATA
is a validComplianceType
that is returned when an Config rule cannot be evaluated. However,INSUFFICIENT_DATA
cannot be used as aComplianceType
for filtering results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.resource_evaluation_id(impl Into<String>)
/set_resource_evaluation_id(Option<String>)
:
required: falseThe unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.
You need to only provide either a
ResourceEvaluationID
or aResourceID
andResourceType
.
- On success, responds with
GetComplianceDetailsByResourceOutput
with field(s):evaluation_results(Option<Vec::<EvaluationResult>>)
:Indicates whether the specified Amazon Web Services resource complies each Config rule.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetComplianceDetailsByResourceError>
Source§impl Client
impl Client
Sourcepub fn get_compliance_summary_by_config_rule(
&self,
) -> GetComplianceSummaryByConfigRuleFluentBuilder
pub fn get_compliance_summary_by_config_rule( &self, ) -> GetComplianceSummaryByConfigRuleFluentBuilder
Constructs a fluent builder for the GetComplianceSummaryByConfigRule
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetComplianceSummaryByConfigRuleOutput
with field(s):compliance_summary(Option<ComplianceSummary>)
:The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.
- On failure, responds with
SdkError<GetComplianceSummaryByConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn get_compliance_summary_by_resource_type(
&self,
) -> GetComplianceSummaryByResourceTypeFluentBuilder
pub fn get_compliance_summary_by_resource_type( &self, ) -> GetComplianceSummaryByResourceTypeFluentBuilder
Constructs a fluent builder for the GetComplianceSummaryByResourceType
operation.
- The fluent builder is configurable:
resource_types(impl Into<String>)
/set_resource_types(Option<Vec::<String>>)
:
required: falseSpecify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.
For this request, you can specify an Amazon Web Services resource type such as
AWS::EC2::Instance
. You can specify that the resource type is an Amazon Web Services account by specifyingAWS::::Account
.
- On success, responds with
GetComplianceSummaryByResourceTypeOutput
with field(s):compliance_summaries_by_resource_type(Option<Vec::<ComplianceSummaryByResourceType>>)
:The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.
- On failure, responds with
SdkError<GetComplianceSummaryByResourceTypeError>
Source§impl Client
impl Client
Sourcepub fn get_conformance_pack_compliance_details(
&self,
) -> GetConformancePackComplianceDetailsFluentBuilder
pub fn get_conformance_pack_compliance_details( &self, ) -> GetConformancePackComplianceDetailsFluentBuilder
Constructs a fluent builder for the GetConformancePackComplianceDetails
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
conformance_pack_name(impl Into<String>)
/set_conformance_pack_name(Option<String>)
:
required: trueName of the conformance pack.
filters(ConformancePackEvaluationFilters)
/set_filters(Option<ConformancePackEvaluationFilters>)
:
required: falseA
ConformancePackEvaluationFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
GetConformancePackComplianceDetailsOutput
with field(s):conformance_pack_name(String)
:Name of the conformance pack.
conformance_pack_rule_evaluation_results(Option<Vec::<ConformancePackEvaluationResult>>)
:Returns a list of
ConformancePackEvaluationResult
objects.next_token(Option<String>)
:The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<GetConformancePackComplianceDetailsError>
Source§impl Client
impl Client
Sourcepub fn get_conformance_pack_compliance_summary(
&self,
) -> GetConformancePackComplianceSummaryFluentBuilder
pub fn get_conformance_pack_compliance_summary( &self, ) -> GetConformancePackComplianceSummaryFluentBuilder
Constructs a fluent builder for the GetConformancePackComplianceSummary
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
conformance_pack_names(impl Into<String>)
/set_conformance_pack_names(Option<Vec::<String>>)
:
required: trueNames of conformance packs.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of conformance packs returned on each page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetConformancePackComplianceSummaryOutput
with field(s):conformance_pack_compliance_summary_list(Option<Vec::<ConformancePackComplianceSummary>>)
:A list of
ConformancePackComplianceSummary
objects.next_token(Option<String>)
:The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetConformancePackComplianceSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_custom_rule_policy(&self) -> GetCustomRulePolicyFluentBuilder
pub fn get_custom_rule_policy(&self) -> GetCustomRulePolicyFluentBuilder
Constructs a fluent builder for the GetCustomRulePolicy
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: falseThe name of your Config Custom Policy rule.
- On success, responds with
GetCustomRulePolicyOutput
with field(s):policy_text(Option<String>)
:The policy definition containing the logic for your Config Custom Policy rule.
- On failure, responds with
SdkError<GetCustomRulePolicyError>
Source§impl Client
impl Client
Sourcepub fn get_discovered_resource_counts(
&self,
) -> GetDiscoveredResourceCountsFluentBuilder
pub fn get_discovered_resource_counts( &self, ) -> GetDiscoveredResourceCountsFluentBuilder
Constructs a fluent builder for the GetDiscoveredResourceCounts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_types(impl Into<String>)
/set_resource_types(Option<Vec::<String>>)
:
required: falseThe comma-separated list that specifies the resource types that you want Config to return (for example,
“AWS::EC2::Instance”
,“AWS::IAM::User”
).If a value for
resourceTypes
is not specified, Config returns all resource types that Config is recording in the region for your account.If the configuration recorder is turned off, Config returns an empty list of
ResourceCount
objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list ofResourceCount
objects.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of
ResourceCount
objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetDiscoveredResourceCountsOutput
with field(s):total_discovered_resources(i64)
:The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify the resource type,“AWS::EC2::Instances”
, in the request. -
Config returns 25 for
totalDiscoveredResources
.
-
resource_counts(Option<Vec::<ResourceCount>>)
:The list of
ResourceCount
objects. Each object is listed in descending order by the number of resources.next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetDiscoveredResourceCountsError>
Source§impl Client
impl Client
Sourcepub fn get_organization_config_rule_detailed_status(
&self,
) -> GetOrganizationConfigRuleDetailedStatusFluentBuilder
pub fn get_organization_config_rule_detailed_status( &self, ) -> GetOrganizationConfigRuleDetailedStatusFluentBuilder
Constructs a fluent builder for the GetOrganizationConfigRuleDetailedStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_config_rule_name(impl Into<String>)
/set_organization_config_rule_name(Option<String>)
:
required: trueThe name of your organization Config rule for which you want status details for member accounts.
filters(StatusDetailFilters)
/set_filters(Option<StatusDetailFilters>)
:
required: falseA
StatusDetailFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of
OrganizationConfigRuleDetailedStatus
returned on each page. If you do not specify a number, Config uses the default. The default is 100.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetOrganizationConfigRuleDetailedStatusOutput
with field(s):organization_config_rule_detailed_status(Option<Vec::<MemberAccountStatus>>)
:A list of
MemberAccountStatus
objects.next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetOrganizationConfigRuleDetailedStatusError>
Source§impl Client
impl Client
Sourcepub fn get_organization_conformance_pack_detailed_status(
&self,
) -> GetOrganizationConformancePackDetailedStatusFluentBuilder
pub fn get_organization_conformance_pack_detailed_status( &self, ) -> GetOrganizationConformancePackDetailedStatusFluentBuilder
Constructs a fluent builder for the GetOrganizationConformancePackDetailedStatus
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_conformance_pack_name(impl Into<String>)
/set_organization_conformance_pack_name(Option<String>)
:
required: trueThe name of organization conformance pack for which you want status details for member accounts.
filters(OrganizationResourceDetailedStatusFilters)
/set_filters(Option<OrganizationResourceDetailedStatusFilters>)
:
required: falseAn
OrganizationResourceDetailedStatusFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of
OrganizationConformancePackDetailedStatuses
returned on each page. If you do not specify a number, Config uses the default. The default is 100.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetOrganizationConformancePackDetailedStatusOutput
with field(s):organization_conformance_pack_detailed_statuses(Option<Vec::<OrganizationConformancePackDetailedStatus>>)
:A list of
OrganizationConformancePackDetailedStatus
objects.next_token(Option<String>)
:The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetOrganizationConformancePackDetailedStatusError>
Source§impl Client
impl Client
Sourcepub fn get_organization_custom_rule_policy(
&self,
) -> GetOrganizationCustomRulePolicyFluentBuilder
pub fn get_organization_custom_rule_policy( &self, ) -> GetOrganizationCustomRulePolicyFluentBuilder
Constructs a fluent builder for the GetOrganizationCustomRulePolicy
operation.
- The fluent builder is configurable:
organization_config_rule_name(impl Into<String>)
/set_organization_config_rule_name(Option<String>)
:
required: trueThe name of your organization Config Custom Policy rule.
- On success, responds with
GetOrganizationCustomRulePolicyOutput
with field(s):policy_text(Option<String>)
:The policy definition containing the logic for your organization Config Custom Policy rule.
- On failure, responds with
SdkError<GetOrganizationCustomRulePolicyError>
Source§impl Client
impl Client
Sourcepub fn get_resource_config_history(
&self,
) -> GetResourceConfigHistoryFluentBuilder
pub fn get_resource_config_history( &self, ) -> GetResourceConfigHistoryFluentBuilder
Constructs a fluent builder for the GetResourceConfigHistory
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_type(ResourceType)
/set_resource_type(Option<ResourceType>)
:
required: trueThe resource type.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource (for example.,
sg-xxxxxx
).later_time(DateTime)
/set_later_time(Option<DateTime>)
:
required: falseThe chronologically latest time in the time range for which the history requested. If not specified, current time is taken.
earlier_time(DateTime)
/set_earlier_time(Option<DateTime>)
:
required: falseThe chronologically earliest time in the time range for which the history requested. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.
chronological_order(ChronologicalOrder)
/set_chronological_order(Option<ChronologicalOrder>)
:
required: falseThe chronological order for configuration items listed. By default, the results are listed in reverse chronological order.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
GetResourceConfigHistoryOutput
with field(s):configuration_items(Option<Vec::<ConfigurationItem>>)
:A list that contains the configuration history of one or more resources.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<GetResourceConfigHistoryError>
Source§impl Client
impl Client
Sourcepub fn get_resource_evaluation_summary(
&self,
) -> GetResourceEvaluationSummaryFluentBuilder
pub fn get_resource_evaluation_summary( &self, ) -> GetResourceEvaluationSummaryFluentBuilder
Constructs a fluent builder for the GetResourceEvaluationSummary
operation.
- The fluent builder is configurable:
resource_evaluation_id(impl Into<String>)
/set_resource_evaluation_id(Option<String>)
:
required: trueThe unique
ResourceEvaluationId
of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
- On success, responds with
GetResourceEvaluationSummaryOutput
with field(s):resource_evaluation_id(Option<String>)
:The unique
ResourceEvaluationId
of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.evaluation_mode(Option<EvaluationMode>)
:Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.
evaluation_status(Option<EvaluationStatus>)
:Returns an
EvaluationStatus
object.evaluation_start_timestamp(Option<DateTime>)
:The start timestamp when Config rule starts evaluating compliance for the provided resource details.
compliance(Option<ComplianceType>)
:The compliance status of the resource evaluation summary.
evaluation_context(Option<EvaluationContext>)
:Returns an
EvaluationContext
object.resource_details(Option<ResourceDetails>)
:Returns a
ResourceDetails
object.
- On failure, responds with
SdkError<GetResourceEvaluationSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_stored_query(&self) -> GetStoredQueryFluentBuilder
pub fn get_stored_query(&self) -> GetStoredQueryFluentBuilder
Constructs a fluent builder for the GetStoredQuery
operation.
- The fluent builder is configurable:
query_name(impl Into<String>)
/set_query_name(Option<String>)
:
required: trueThe name of the query.
- On success, responds with
GetStoredQueryOutput
with field(s):stored_query(Option<StoredQuery>)
:Returns a
StoredQuery
object.
- On failure, responds with
SdkError<GetStoredQueryError>
Source§impl Client
impl Client
Sourcepub fn list_aggregate_discovered_resources(
&self,
) -> ListAggregateDiscoveredResourcesFluentBuilder
pub fn list_aggregate_discovered_resources( &self, ) -> ListAggregateDiscoveredResourcesFluentBuilder
Constructs a fluent builder for the ListAggregateDiscoveredResources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
resource_type(ResourceType)
/set_resource_type(Option<ResourceType>)
:
required: trueThe type of resources that you want Config to list in the response.
filters(ResourceFilters)
/set_filters(Option<ResourceFilters>)
:
required: falseFilters the results based on the
ResourceFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
ListAggregateDiscoveredResourcesOutput
with field(s):resource_identifiers(Option<Vec::<AggregateResourceIdentifier>>)
:Returns a list of
ResourceIdentifiers
objects.next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<ListAggregateDiscoveredResourcesError>
Source§impl Client
impl Client
Sourcepub fn list_configuration_recorders(
&self,
) -> ListConfigurationRecordersFluentBuilder
pub fn list_configuration_recorders( &self, ) -> ListConfigurationRecordersFluentBuilder
Constructs a fluent builder for the ListConfigurationRecorders
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(ConfigurationRecorderFilter)
/set_filters(Option<Vec::<ConfigurationRecorderFilter>>)
:
required: falseFilters the results based on a list of
ConfigurationRecorderFilter
objects that you specify.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
NextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
ListConfigurationRecordersOutput
with field(s):configuration_recorder_summaries(Vec::<ConfigurationRecorderSummary>)
:A list of
ConfigurationRecorderSummary
objects that includes.next_token(Option<String>)
:The
NextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<ListConfigurationRecordersError>
Source§impl Client
impl Client
Sourcepub fn list_conformance_pack_compliance_scores(
&self,
) -> ListConformancePackComplianceScoresFluentBuilder
pub fn list_conformance_pack_compliance_scores( &self, ) -> ListConformancePackComplianceScoresFluentBuilder
Constructs a fluent builder for the ListConformancePackComplianceScores
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(ConformancePackComplianceScoresFilters)
/set_filters(Option<ConformancePackComplianceScoresFilters>)
:
required: falseFilters the results based on the
ConformancePackComplianceScoresFilters
.sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:
required: falseDetermines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.
By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter
DESCENDING
.You can sort conformance pack compliance scores by the numerical value of the compliance score by entering
SCORE
in theSortBy
action. When compliance scores are sorted bySCORE
, conformance packs with a compliance score ofINSUFFICIENT_DATA
will be last when sorting by ascending order and first when sorting by descending order.sort_by(SortBy)
/set_sort_by(Option<SortBy>)
:
required: falseSorts your conformance pack compliance scores in either ascending or descending order, depending on
SortOrder
.By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter
SCORE
, to sort conformance pack compliance scores by the numerical value of the compliance score.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of conformance pack compliance scores returned on each page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string in a prior request that you can use to get the paginated response for the next set of conformance pack compliance scores.
- On success, responds with
ListConformancePackComplianceScoresOutput
with field(s):next_token(Option<String>)
:The
nextToken
string that you can use to get the next page of results in a paginated response.conformance_pack_compliance_scores(Vec::<ConformancePackComplianceScore>)
:A list of
ConformancePackComplianceScore
objects.
- On failure, responds with
SdkError<ListConformancePackComplianceScoresError>
Source§impl Client
impl Client
Sourcepub fn list_discovered_resources(&self) -> ListDiscoveredResourcesFluentBuilder
pub fn list_discovered_resources(&self) -> ListDiscoveredResourcesFluentBuilder
Constructs a fluent builder for the ListDiscoveredResources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_type(ResourceType)
/set_resource_type(Option<ResourceType>)
:
required: trueThe type of resources that you want Config to list in the response.
resource_ids(impl Into<String>)
/set_resource_ids(Option<Vec::<String>>)
:
required: falseThe IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:
required: falseThe custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
include_deleted_resources(bool)
/set_include_deleted_resources(Option<bool>)
:
required: falseSpecifies whether Config includes deleted resources in the results. By default, deleted resources are not included.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
ListDiscoveredResourcesOutput
with field(s):resource_identifiers(Option<Vec::<ResourceIdentifier>>)
:The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.
next_token(Option<String>)
:The string that you use in a subsequent request to get the next page of results in a paginated response.
- On failure, responds with
SdkError<ListDiscoveredResourcesError>
Source§impl Client
impl Client
Sourcepub fn list_resource_evaluations(&self) -> ListResourceEvaluationsFluentBuilder
pub fn list_resource_evaluations(&self) -> ListResourceEvaluationsFluentBuilder
Constructs a fluent builder for the ListResourceEvaluations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(ResourceEvaluationFilters)
/set_filters(Option<ResourceEvaluationFilters>)
:
required: falseReturns a
ResourceEvaluationFilters
object.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
ListResourceEvaluationsOutput
with field(s):resource_evaluations(Option<Vec::<ResourceEvaluation>>)
:Returns a
ResourceEvaluations
object.next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<ListResourceEvaluationsError>
Source§impl Client
impl Client
Sourcepub fn list_stored_queries(&self) -> ListStoredQueriesFluentBuilder
pub fn list_stored_queries(&self) -> ListStoredQueriesFluentBuilder
Constructs a fluent builder for the ListStoredQueries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned with a single call.
- On success, responds with
ListStoredQueriesOutput
with field(s):stored_query_metadata(Option<Vec::<StoredQueryMetadata>>)
:A list of
StoredQueryMetadata
objects.next_token(Option<String>)
:If the previous paginated request didn’t return all of the remaining results, the response object’s
NextToken
parameter value is set to a token. To retrieve the next set of results, call this operation again and assign that token to the request object’sNextToken
parameter. If there are no remaining results, the previous response object’sNextToken
parameter is set tonull
.
- On failure, responds with
SdkError<ListStoredQueriesError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported:
-
ConfigurationRecorder
-
ConfigRule
-
OrganizationConfigRule
-
ConformancePack
-
OrganizationConformancePack
-
ConfigurationAggregator
-
AggregationAuthorization
-
StoredQuery
-
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:The tags for the resource.
next_token(Option<String>)
:The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Constructs a fluent builder for the PutAggregationAuthorization
operation.
- The fluent builder is configurable:
authorized_account_id(impl Into<String>)
/set_authorized_account_id(Option<String>)
:
required: trueThe 12-digit account ID of the account authorized to aggregate data.
authorized_aws_region(impl Into<String>)
/set_authorized_aws_region(Option<String>)
:
required: trueThe region authorized to collect aggregated data.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn array of tag object.
- On success, responds with
PutAggregationAuthorizationOutput
with field(s):aggregation_authorization(Option<AggregationAuthorization>)
:Returns an AggregationAuthorization object.
- On failure, responds with
SdkError<PutAggregationAuthorizationError>
Source§impl Client
impl Client
Sourcepub fn put_config_rule(&self) -> PutConfigRuleFluentBuilder
pub fn put_config_rule(&self) -> PutConfigRuleFluentBuilder
Constructs a fluent builder for the PutConfigRule
operation.
- The fluent builder is configurable:
config_rule(ConfigRule)
/set_config_rule(Option<ConfigRule>)
:
required: trueThe rule that you want to add to your account.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn array of tag object.
- On success, responds with
PutConfigRuleOutput
- On failure, responds with
SdkError<PutConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn put_configuration_aggregator(
&self,
) -> PutConfigurationAggregatorFluentBuilder
pub fn put_configuration_aggregator( &self, ) -> PutConfigurationAggregatorFluentBuilder
Constructs a fluent builder for the PutConfigurationAggregator
operation.
- The fluent builder is configurable:
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
account_aggregation_sources(AccountAggregationSource)
/set_account_aggregation_sources(Option<Vec::<AccountAggregationSource>>)
:
required: falseA list of AccountAggregationSource object.
organization_aggregation_source(OrganizationAggregationSource)
/set_organization_aggregation_source(Option<OrganizationAggregationSource>)
:
required: falseAn OrganizationAggregationSource object.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn array of tag object.
aggregator_filters(AggregatorFilters)
/set_aggregator_filters(Option<AggregatorFilters>)
:
required: falseAn object to filter configuration recorders in an aggregator. Either
ResourceType
orServicePrincipal
is required.
- On success, responds with
PutConfigurationAggregatorOutput
with field(s):configuration_aggregator(Option<ConfigurationAggregator>)
:Returns a ConfigurationAggregator object.
- On failure, responds with
SdkError<PutConfigurationAggregatorError>
Source§impl Client
impl Client
Sourcepub fn put_configuration_recorder(
&self,
) -> PutConfigurationRecorderFluentBuilder
pub fn put_configuration_recorder( &self, ) -> PutConfigurationRecorderFluentBuilder
Constructs a fluent builder for the PutConfigurationRecorder
operation.
- The fluent builder is configurable:
configuration_recorder(ConfigurationRecorder)
/set_configuration_recorder(Option<ConfigurationRecorder>)
:
required: trueAn object for the configuration recorder. A configuration recorder records configuration changes for the resource types in scope.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags for the customer managed configuration recorder. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
PutConfigurationRecorderOutput
- On failure, responds with
SdkError<PutConfigurationRecorderError>
Source§impl Client
impl Client
Sourcepub fn put_conformance_pack(&self) -> PutConformancePackFluentBuilder
pub fn put_conformance_pack(&self) -> PutConformancePackFluentBuilder
Constructs a fluent builder for the PutConformancePack
operation.
- The fluent builder is configurable:
conformance_pack_name(impl Into<String>)
/set_conformance_pack_name(Option<String>)
:
required: trueThe unique name of the conformance pack you want to deploy.
template_s3_uri(impl Into<String>)
/set_template_s3_uri(Option<String>)
:
required: falseThe location of the file containing the template body (
s3://bucketname/prefix
). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:
required: falseA string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.
You can use a YAML template with two resource types: Config rule (
AWS::Config::ConfigRule
) and remediation action (AWS::Config::RemediationConfiguration
).delivery_s3_bucket(impl Into<String>)
/set_delivery_s3_bucket(Option<String>)
:
required: falseThe name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
delivery_s3_key_prefix(impl Into<String>)
/set_delivery_s3_key_prefix(Option<String>)
:
required: falseThe prefix for the Amazon S3 bucket.
This field is optional.
conformance_pack_input_parameters(ConformancePackInputParameter)
/set_conformance_pack_input_parameters(Option<Vec::<ConformancePackInputParameter>>)
:
required: falseA list of
ConformancePackInputParameter
objects.template_ssm_document_details(TemplateSsmDocumentDetails)
/set_template_ssm_document_details(Option<TemplateSsmDocumentDetails>)
:
required: falseAn object of type
TemplateSSMDocumentDetails
, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.
- On success, responds with
PutConformancePackOutput
with field(s):conformance_pack_arn(Option<String>)
:ARN of the conformance pack.
- On failure, responds with
SdkError<PutConformancePackError>
Source§impl Client
impl Client
Sourcepub fn put_delivery_channel(&self) -> PutDeliveryChannelFluentBuilder
pub fn put_delivery_channel(&self) -> PutDeliveryChannelFluentBuilder
Constructs a fluent builder for the PutDeliveryChannel
operation.
- The fluent builder is configurable:
delivery_channel(DeliveryChannel)
/set_delivery_channel(Option<DeliveryChannel>)
:
required: trueAn object for the delivery channel. A delivery channel sends notifications and updated configuration states.
- On success, responds with
PutDeliveryChannelOutput
- On failure, responds with
SdkError<PutDeliveryChannelError>
Source§impl Client
impl Client
Sourcepub fn put_evaluations(&self) -> PutEvaluationsFluentBuilder
pub fn put_evaluations(&self) -> PutEvaluationsFluentBuilder
Constructs a fluent builder for the PutEvaluations
operation.
- The fluent builder is configurable:
evaluations(Evaluation)
/set_evaluations(Option<Vec::<Evaluation>>)
:
required: falseThe assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.
result_token(impl Into<String>)
/set_result_token(Option<String>)
:
required: trueAn encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.
test_mode(bool)
/set_test_mode(Option<bool>)
:
required: falseUse this parameter to specify a test run for
PutEvaluations
. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.When
TestMode
istrue
,PutEvaluations
doesn’t require a valid value for theResultToken
parameter, but the value cannot be null.
- On success, responds with
PutEvaluationsOutput
with field(s):failed_evaluations(Option<Vec::<Evaluation>>)
:Requests that failed because of a client or server error.
- On failure, responds with
SdkError<PutEvaluationsError>
Source§impl Client
impl Client
Sourcepub fn put_external_evaluation(&self) -> PutExternalEvaluationFluentBuilder
pub fn put_external_evaluation(&self) -> PutExternalEvaluationFluentBuilder
Constructs a fluent builder for the PutExternalEvaluation
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule.
external_evaluation(ExternalEvaluation)
/set_external_evaluation(Option<ExternalEvaluation>)
:
required: trueAn
ExternalEvaluation
object that provides details about compliance.
- On success, responds with
PutExternalEvaluationOutput
- On failure, responds with
SdkError<PutExternalEvaluationError>
Source§impl Client
impl Client
Sourcepub fn put_organization_config_rule(
&self,
) -> PutOrganizationConfigRuleFluentBuilder
pub fn put_organization_config_rule( &self, ) -> PutOrganizationConfigRuleFluentBuilder
Constructs a fluent builder for the PutOrganizationConfigRule
operation.
- The fluent builder is configurable:
organization_config_rule_name(impl Into<String>)
/set_organization_config_rule_name(Option<String>)
:
required: trueThe name that you assign to an organization Config rule.
organization_managed_rule_metadata(OrganizationManagedRuleMetadata)
/set_organization_managed_rule_metadata(Option<OrganizationManagedRuleMetadata>)
:
required: falseAn
OrganizationManagedRuleMetadata
object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.organization_custom_rule_metadata(OrganizationCustomRuleMetadata)
/set_organization_custom_rule_metadata(Option<OrganizationCustomRuleMetadata>)
:
required: falseAn
OrganizationCustomRuleMetadata
object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.excluded_accounts(impl Into<String>)
/set_excluded_accounts(Option<Vec::<String>>)
:
required: falseA comma-separated list of accounts that you want to exclude from an organization Config rule.
organization_custom_policy_rule_metadata(OrganizationCustomPolicyRuleMetadata)
/set_organization_custom_policy_rule_metadata(Option<OrganizationCustomPolicyRuleMetadata>)
:
required: falseAn
OrganizationCustomPolicyRuleMetadata
object. This object specifies metadata for your organization’s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.
- On success, responds with
PutOrganizationConfigRuleOutput
with field(s):organization_config_rule_arn(Option<String>)
:The Amazon Resource Name (ARN) of an organization Config rule.
- On failure, responds with
SdkError<PutOrganizationConfigRuleError>
Source§impl Client
impl Client
Sourcepub fn put_organization_conformance_pack(
&self,
) -> PutOrganizationConformancePackFluentBuilder
pub fn put_organization_conformance_pack( &self, ) -> PutOrganizationConformancePackFluentBuilder
Constructs a fluent builder for the PutOrganizationConformancePack
operation.
- The fluent builder is configurable:
organization_conformance_pack_name(impl Into<String>)
/set_organization_conformance_pack_name(Option<String>)
:
required: trueName of the organization conformance pack you want to create.
template_s3_uri(impl Into<String>)
/set_template_s3_uri(Option<String>)
:
required: falseLocation of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).
You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:
required: falseA string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
delivery_s3_bucket(impl Into<String>)
/set_delivery_s3_bucket(Option<String>)
:
required: falseThe name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional. If used, it must be prefixed with
awsconfigconforms
.delivery_s3_key_prefix(impl Into<String>)
/set_delivery_s3_key_prefix(Option<String>)
:
required: falseThe prefix for the Amazon S3 bucket.
This field is optional.
conformance_pack_input_parameters(ConformancePackInputParameter)
/set_conformance_pack_input_parameters(Option<Vec::<ConformancePackInputParameter>>)
:
required: falseA list of
ConformancePackInputParameter
objects.excluded_accounts(impl Into<String>)
/set_excluded_accounts(Option<Vec::<String>>)
:
required: falseA list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.
- On success, responds with
PutOrganizationConformancePackOutput
with field(s):organization_conformance_pack_arn(Option<String>)
:ARN of the organization conformance pack.
- On failure, responds with
SdkError<PutOrganizationConformancePackError>
Source§impl Client
impl Client
Sourcepub fn put_remediation_configurations(
&self,
) -> PutRemediationConfigurationsFluentBuilder
pub fn put_remediation_configurations( &self, ) -> PutRemediationConfigurationsFluentBuilder
Constructs a fluent builder for the PutRemediationConfigurations
operation.
- The fluent builder is configurable:
remediation_configurations(RemediationConfiguration)
/set_remediation_configurations(Option<Vec::<RemediationConfiguration>>)
:
required: trueA list of remediation configuration objects.
- On success, responds with
PutRemediationConfigurationsOutput
with field(s):failed_batches(Option<Vec::<FailedRemediationBatch>>)
:Returns a list of failed remediation batch objects.
- On failure, responds with
SdkError<PutRemediationConfigurationsError>
Source§impl Client
impl Client
Sourcepub fn put_remediation_exceptions(
&self,
) -> PutRemediationExceptionsFluentBuilder
pub fn put_remediation_exceptions( &self, ) -> PutRemediationExceptionsFluentBuilder
Constructs a fluent builder for the PutRemediationExceptions
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe name of the Config rule for which you want to create remediation exception.
resource_keys(RemediationExceptionResourceKey)
/set_resource_keys(Option<Vec::<RemediationExceptionResourceKey>>)
:
required: trueAn exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
message(impl Into<String>)
/set_message(Option<String>)
:
required: falseThe message contains an explanation of the exception.
expiration_time(DateTime)
/set_expiration_time(Option<DateTime>)
:
required: falseThe exception is automatically deleted after the expiration date.
- On success, responds with
PutRemediationExceptionsOutput
with field(s):failed_batches(Option<Vec::<FailedRemediationExceptionBatch>>)
:Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
- On failure, responds with
SdkError<PutRemediationExceptionsError>
Source§impl Client
impl Client
Sourcepub fn put_resource_config(&self) -> PutResourceConfigFluentBuilder
pub fn put_resource_config(&self) -> PutResourceConfigFluentBuilder
Constructs a fluent builder for the PutResourceConfig
operation.
- The fluent builder is configurable:
resource_type(impl Into<String>)
/set_resource_type(Option<String>)
:
required: trueThe type of the resource. The custom resource type must be registered with CloudFormation.
You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
schema_version_id(impl Into<String>)
/set_schema_version_id(Option<String>)
:
required: trueVersion of the schema registered for the ResourceType in CloudFormation.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueUnique identifier of the resource.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:
required: falseName of the resource.
configuration(impl Into<String>)
/set_configuration(Option<String>)
:
required: trueThe configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.
The configuration JSON must not exceed 64 KB.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags associated with the resource.
This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for
PutResourceConfig
are tags that you supply for the configuration items of your custom resources.
- On success, responds with
PutResourceConfigOutput
- On failure, responds with
SdkError<PutResourceConfigError>
Source§impl Client
impl Client
Sourcepub fn put_retention_configuration(
&self,
) -> PutRetentionConfigurationFluentBuilder
pub fn put_retention_configuration( &self, ) -> PutRetentionConfigurationFluentBuilder
Constructs a fluent builder for the PutRetentionConfiguration
operation.
- The fluent builder is configurable:
retention_period_in_days(i32)
/set_retention_period_in_days(Option<i32>)
:
required: trueNumber of days Config stores your historical information.
Currently, only applicable to the configuration item history.
- On success, responds with
PutRetentionConfigurationOutput
with field(s):retention_configuration(Option<RetentionConfiguration>)
:Returns a retention configuration object.
- On failure, responds with
SdkError<PutRetentionConfigurationError>
Source§impl Client
impl Client
Sourcepub fn put_service_linked_configuration_recorder(
&self,
) -> PutServiceLinkedConfigurationRecorderFluentBuilder
pub fn put_service_linked_configuration_recorder( &self, ) -> PutServiceLinkedConfigurationRecorderFluentBuilder
Constructs a fluent builder for the PutServiceLinkedConfigurationRecorder
operation.
- The fluent builder is configurable:
service_principal(impl Into<String>)
/set_service_principal(Option<String>)
:
required: trueThe service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to create.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags for a service-linked configuration recorder. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
PutServiceLinkedConfigurationRecorderOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the specified configuration recorder.
name(Option<String>)
:The name of the specified configuration recorder.
For service-linked configuration recorders, Config automatically assigns a name that has the prefix “
AWS
” to the new service-linked configuration recorder.
- On failure, responds with
SdkError<PutServiceLinkedConfigurationRecorderError>
Source§impl Client
impl Client
Sourcepub fn put_stored_query(&self) -> PutStoredQueryFluentBuilder
pub fn put_stored_query(&self) -> PutStoredQueryFluentBuilder
Constructs a fluent builder for the PutStoredQuery
operation.
- The fluent builder is configurable:
stored_query(StoredQuery)
/set_stored_query(Option<StoredQuery>)
:
required: trueA list of
StoredQuery
objects. The mandatory fields areQueryName
andExpression
.When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tags
object.
- On success, responds with
PutStoredQueryOutput
with field(s):query_arn(Option<String>)
:Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.
- On failure, responds with
SdkError<PutStoredQueryError>
Source§impl Client
impl Client
Sourcepub fn select_aggregate_resource_config(
&self,
) -> SelectAggregateResourceConfigFluentBuilder
pub fn select_aggregate_resource_config( &self, ) -> SelectAggregateResourceConfigFluentBuilder
Constructs a fluent builder for the SelectAggregateResourceConfig
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
expression(impl Into<String>)
/set_expression(Option<String>)
:
required: trueThe SQL query SELECT command.
configuration_aggregator_name(impl Into<String>)
/set_configuration_aggregator_name(Option<String>)
:
required: trueThe name of the configuration aggregator.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of query results returned on each page.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of query results returned on each page. Config also allows the Limit request parameter.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
SelectAggregateResourceConfigOutput
with field(s):results(Option<Vec::<String>>)
:Returns the results for the SQL query.
query_info(Option<QueryInfo>)
:Details about the query.
next_token(Option<String>)
:The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<SelectAggregateResourceConfigError>
Source§impl Client
impl Client
Sourcepub fn select_resource_config(&self) -> SelectResourceConfigFluentBuilder
pub fn select_resource_config(&self) -> SelectResourceConfigFluentBuilder
Constructs a fluent builder for the SelectResourceConfig
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
expression(impl Into<String>)
/set_expression(Option<String>)
:
required: trueThe SQL query
SELECT
command.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of query results returned on each page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On success, responds with
SelectResourceConfigOutput
with field(s):results(Option<Vec::<String>>)
:Returns the results for the SQL query.
query_info(Option<QueryInfo>)
:Returns the
QueryInfo
object.next_token(Option<String>)
:The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
- On failure, responds with
SdkError<SelectResourceConfigError>
Source§impl Client
impl Client
Sourcepub fn start_config_rules_evaluation(
&self,
) -> StartConfigRulesEvaluationFluentBuilder
pub fn start_config_rules_evaluation( &self, ) -> StartConfigRulesEvaluationFluentBuilder
Constructs a fluent builder for the StartConfigRulesEvaluation
operation.
- The fluent builder is configurable:
config_rule_names(impl Into<String>)
/set_config_rule_names(Option<Vec::<String>>)
:
required: falseThe list of names of Config rules that you want to run evaluations for.
- On success, responds with
StartConfigRulesEvaluationOutput
- On failure, responds with
SdkError<StartConfigRulesEvaluationError>
Source§impl Client
impl Client
Sourcepub fn start_configuration_recorder(
&self,
) -> StartConfigurationRecorderFluentBuilder
pub fn start_configuration_recorder( &self, ) -> StartConfigurationRecorderFluentBuilder
Constructs a fluent builder for the StartConfigurationRecorder
operation.
- The fluent builder is configurable:
configuration_recorder_name(impl Into<String>)
/set_configuration_recorder_name(Option<String>)
:
required: trueThe name of the customer managed configuration recorder that you want to start.
- On success, responds with
StartConfigurationRecorderOutput
- On failure, responds with
SdkError<StartConfigurationRecorderError>
Source§impl Client
impl Client
Sourcepub fn start_remediation_execution(
&self,
) -> StartRemediationExecutionFluentBuilder
pub fn start_remediation_execution( &self, ) -> StartRemediationExecutionFluentBuilder
Constructs a fluent builder for the StartRemediationExecution
operation.
- The fluent builder is configurable:
config_rule_name(impl Into<String>)
/set_config_rule_name(Option<String>)
:
required: trueThe list of names of Config rules that you want to run remediation execution for.
resource_keys(ResourceKey)
/set_resource_keys(Option<Vec::<ResourceKey>>)
:
required: trueA list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
- On success, responds with
StartRemediationExecutionOutput
with field(s):failure_message(Option<String>)
:Returns a failure message. For example, the resource is already compliant.
failed_items(Option<Vec::<ResourceKey>>)
:For resources that have failed to start execution, the API returns a resource key object.
- On failure, responds with
SdkError<StartRemediationExecutionError>
Source§impl Client
impl Client
Sourcepub fn start_resource_evaluation(&self) -> StartResourceEvaluationFluentBuilder
pub fn start_resource_evaluation(&self) -> StartResourceEvaluationFluentBuilder
Constructs a fluent builder for the StartResourceEvaluation
operation.
- The fluent builder is configurable:
resource_details(ResourceDetails)
/set_resource_details(Option<ResourceDetails>)
:
required: trueReturns a
ResourceDetails
object.evaluation_context(EvaluationContext)
/set_evaluation_context(Option<EvaluationContext>)
:
required: falseReturns an
EvaluationContext
object.evaluation_mode(EvaluationMode)
/set_evaluation_mode(Option<EvaluationMode>)
:
required: trueThe mode of an evaluation. The valid values for this API are
DETECTIVE
andPROACTIVE
.evaluation_timeout(i32)
/set_evaluation_timeout(Option<i32>)
:
required: falseThe timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.
Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.
- On success, responds with
StartResourceEvaluationOutput
with field(s):resource_evaluation_id(Option<String>)
:A unique ResourceEvaluationId that is associated with a single execution.
- On failure, responds with
SdkError<StartResourceEvaluationError>
Source§impl Client
impl Client
Sourcepub fn stop_configuration_recorder(
&self,
) -> StopConfigurationRecorderFluentBuilder
pub fn stop_configuration_recorder( &self, ) -> StopConfigurationRecorderFluentBuilder
Constructs a fluent builder for the StopConfigurationRecorder
operation.
- The fluent builder is configurable:
configuration_recorder_name(impl Into<String>)
/set_configuration_recorder_name(Option<String>)
:
required: trueThe name of the customer managed configuration recorder that you want to stop.
- On success, responds with
StopConfigurationRecorderOutput
- On failure, responds with
SdkError<StopConfigurationRecorderError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported:
-
ConfigurationRecorder
-
ConfigRule
-
OrganizationConfigRule
-
ConformancePack
-
OrganizationConformancePack
-
ConfigurationAggregator
-
AggregationAuthorization
-
StoredQuery
-
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueAn array of tag object.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that identifies the resource for which to list the tags. The following resources are supported:
-
ConfigurationRecorder
-
ConfigRule
-
OrganizationConfigRule
-
ConformancePack
-
OrganizationConformancePack
-
ConfigurationAggregator
-
AggregationAuthorization
-
StoredQuery
-
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe keys of the tags to be removed.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);