Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/configservice.ts?docs=full";

§Classes

ConfigService

§Interfaces

AccountAggregationSource

A collection of accounts and regions.

AggregateComplianceByConfigRule

Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

AggregateComplianceByConformancePack

Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.

AggregateComplianceCount

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

AggregateConformancePackCompliance

Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

AggregateConformancePackComplianceCount

The number of conformance packs that are compliant and noncompliant.

AggregateConformancePackComplianceFilters

Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack.

AggregateConformancePackComplianceSummary

Provides a summary of compliance based on either account ID or region.

AggregateConformancePackComplianceSummaryFilters

Filters the results based on account ID and region.

AggregatedSourceStatus

The current sync status between the source and the aggregator account.

AggregateEvaluationResult

The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

AggregateResourceIdentifier

The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.

AggregationAuthorization

An object that represents the authorizations granted to aggregator accounts and regions.

BaseConfigurationItem

The detailed configuration of a specified resource.

BatchGetAggregateResourceConfigRequest
BatchGetAggregateResourceConfigResponse
BatchGetResourceConfigRequest
BatchGetResourceConfigResponse
Compliance

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

ComplianceByConfigRule

Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.

ComplianceByResource

Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

ComplianceContributorCount

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item, up to a maximum number.

ComplianceSummary

The number of Config rules or Amazon Web Services resources that are compliant and noncompliant.

ComplianceSummaryByResourceType

The number of Amazon Web Services resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.

ConfigExportDeliveryInfo

Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.

ConfigRule

An Config rule represents an Lambda function that you create for a custom rule or a predefined function for an Config managed rule. The function evaluates configuration items to assess whether your Amazon Web Services resources comply with your desired configurations. This function can run when Config detects a configuration change to an Amazon Web Services resource and at a periodic frequency that you choose (for example, every 24 hours).

ConfigRuleComplianceFilters

Filters the compliance results based on account ID, region, compliance type, and rule name.

ConfigRuleComplianceSummaryFilters

Filters the results based on the account IDs and regions.

ConfigRuleEvaluationStatus

Status information for your Config managed rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

ConfigSnapshotDeliveryProperties

Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

ConfigStreamDeliveryInfo

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

ConfigurationAggregator

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

ConfigurationItem

A list that contains detailed configurations of a specified resource.

ConfigurationRecorder

An object that represents the recording of configuration changes of an Amazon Web Services resource.

ConfigurationRecorderStatus

The current status of the configuration recorder.

ConformancePackComplianceFilters

Filters the conformance pack by compliance types and Config rule names.

ConformancePackComplianceSummary

Summary includes the name and status of the conformance pack.

ConformancePackDetail

Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.

ConformancePackEvaluationFilters

Filters a conformance pack by Config rule names, compliance types, Amazon Web Services resource types, and resource IDs.

ConformancePackEvaluationResult

The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information.

ConformancePackInputParameter

Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

ConformancePackRuleCompliance

Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

ConformancePackStatusDetail

Status details of a conformance pack.

DeleteAggregationAuthorizationRequest
DeleteConfigRuleRequest
DeleteConfigurationAggregatorRequest
DeleteConfigurationRecorderRequest

The request object for the DeleteConfigurationRecorder action.

DeleteConformancePackRequest
DeleteDeliveryChannelRequest

The input for the "DeleteDeliveryChannel" action. The action accepts the following data, in JSON format.

DeleteEvaluationResultsRequest
DeleteOrganizationConfigRuleRequest
DeleteOrganizationConformancePackRequest
DeletePendingAggregationRequestRequest
DeleteRemediationConfigurationRequest
DeleteRemediationExceptionsRequest
DeleteRemediationExceptionsResponse
DeleteResourceConfigRequest
DeleteRetentionConfigurationRequest
DeleteStoredQueryRequest
DeliverConfigSnapshotRequest

The input for the "DeliverConfigSnapshot" action.

DeliverConfigSnapshotResponse

The output for the "DeliverConfigSnapshot" action, in JSON format.

DeliveryChannel

The channel through which Config delivers notifications and updated configuration states.

DeliveryChannelStatus

The status of a specified delivery channel.

DescribeAggregateComplianceByConfigRulesRequest
DescribeAggregateComplianceByConfigRulesResponse
DescribeAggregateComplianceByConformancePacksRequest
DescribeAggregateComplianceByConformancePacksResponse
DescribeAggregationAuthorizationsRequest
DescribeAggregationAuthorizationsResponse
DescribeComplianceByConfigRuleRequest
DescribeComplianceByConfigRuleResponse
DescribeComplianceByResourceRequest
DescribeComplianceByResourceResponse
DescribeConfigRuleEvaluationStatusRequest
DescribeConfigRuleEvaluationStatusResponse
DescribeConfigRulesRequest
DescribeConfigRulesResponse
DescribeConfigurationAggregatorSourcesStatusRequest
DescribeConfigurationAggregatorSourcesStatusResponse
DescribeConfigurationAggregatorsRequest
DescribeConfigurationAggregatorsResponse
DescribeConfigurationRecordersRequest

The input for the "DescribeConfigurationRecorders" action.

DescribeConfigurationRecordersResponse

The output for the "DescribeConfigurationRecorders" action.

DescribeConfigurationRecorderStatusRequest

The input for the "DescribeConfigurationRecorderStatus" action.

DescribeConfigurationRecorderStatusResponse

The output for the "DescribeConfigurationRecorderStatus" action, in JSON format.

DescribeConformancePackComplianceRequest
DescribeConformancePackComplianceResponse
DescribeConformancePacksRequest
DescribeConformancePacksResponse
DescribeConformancePackStatusRequest
DescribeConformancePackStatusResponse
DescribeDeliveryChannelsRequest

The input for the "DescribeDeliveryChannels" action.

DescribeDeliveryChannelsResponse

The output for the "DescribeDeliveryChannels" action.

DescribeDeliveryChannelStatusRequest

The input for the "DeliveryChannelStatus" action.

DescribeDeliveryChannelStatusResponse

The output for the "DescribeDeliveryChannelStatus" action.

DescribeOrganizationConfigRulesRequest
DescribeOrganizationConfigRulesResponse
DescribeOrganizationConfigRuleStatusesRequest
DescribeOrganizationConfigRuleStatusesResponse
DescribeOrganizationConformancePacksRequest
DescribeOrganizationConformancePacksResponse
DescribeOrganizationConformancePackStatusesRequest
DescribeOrganizationConformancePackStatusesResponse
DescribePendingAggregationRequestsRequest
DescribePendingAggregationRequestsResponse
DescribeRemediationConfigurationsRequest
DescribeRemediationConfigurationsResponse
DescribeRemediationExceptionsRequest
DescribeRemediationExceptionsResponse
DescribeRemediationExecutionStatusRequest
DescribeRemediationExecutionStatusResponse
DescribeRetentionConfigurationsRequest
DescribeRetentionConfigurationsResponse
Evaluation

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

EvaluationResult

The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

EvaluationResultIdentifier

Uniquely identifies an evaluation result.

EvaluationResultQualifier

Identifies an Config rule that evaluated an Amazon Web Services resource, and provides the type and ID of the resource that the rule evaluated.

ExecutionControls

The controls that Config uses for executing remediations.

ExternalEvaluation

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

FailedDeleteRemediationExceptionsBatch

List of each of the failed delete remediation exceptions with specific reasons.

FailedRemediationBatch

List of each of the failed remediations with specific reasons.

FailedRemediationExceptionBatch

List of each of the failed remediation exceptions with specific reasons.

FieldInfo

Details about the fields such as name of the field.

GetAggregateComplianceDetailsByConfigRuleRequest
GetAggregateComplianceDetailsByConfigRuleResponse
GetAggregateConfigRuleComplianceSummaryRequest
GetAggregateConfigRuleComplianceSummaryResponse
GetAggregateConformancePackComplianceSummaryRequest
GetAggregateConformancePackComplianceSummaryResponse
GetAggregateDiscoveredResourceCountsRequest
GetAggregateDiscoveredResourceCountsResponse
GetAggregateResourceConfigRequest
GetAggregateResourceConfigResponse
GetComplianceDetailsByConfigRuleRequest
GetComplianceDetailsByConfigRuleResponse
GetComplianceDetailsByResourceRequest
GetComplianceDetailsByResourceResponse
GetComplianceSummaryByConfigRuleResponse
GetComplianceSummaryByResourceTypeRequest
GetComplianceSummaryByResourceTypeResponse
GetConformancePackComplianceDetailsRequest
GetConformancePackComplianceDetailsResponse
GetConformancePackComplianceSummaryRequest
GetConformancePackComplianceSummaryResponse
GetDiscoveredResourceCountsRequest
GetDiscoveredResourceCountsResponse
GetOrganizationConfigRuleDetailedStatusRequest
GetOrganizationConfigRuleDetailedStatusResponse
GetOrganizationConformancePackDetailedStatusRequest
GetOrganizationConformancePackDetailedStatusResponse
GetResourceConfigHistoryRequest

The input for the "GetResourceConfigHistory" action.

GetResourceConfigHistoryResponse

The output for the "GetResourceConfigHistory" action.

GetStoredQueryRequest
GetStoredQueryResponse
GroupedResourceCount

The count of resources that are grouped by the group name.

ListAggregateDiscoveredResourcesRequest
ListAggregateDiscoveredResourcesResponse
ListDiscoveredResourcesRequest
ListDiscoveredResourcesResponse
ListStoredQueriesRequest
ListStoredQueriesResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
MemberAccountStatus

Organization config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

OrganizationAggregationSource

This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

OrganizationConfigRule

An organization config rule that has information about config rules that Config creates in member accounts.

OrganizationConfigRuleStatus

Returns the status for an organization config rule in an organization.

OrganizationConformancePack

An organization conformance pack that has information about conformance packs that Config creates in member accounts.

OrganizationConformancePackDetailedStatus

Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed.

OrganizationConformancePackStatus

Returns the status for an organization conformance pack in an organization.

OrganizationCustomRuleMetadata

An object that 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.

OrganizationManagedRuleMetadata

An object that 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.

OrganizationResourceDetailedStatusFilters

Status filter object to filter results based on specific member account ID or status type for an organization conformance pack.

PendingAggregationRequest

An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.

PutAggregationAuthorizationRequest
PutAggregationAuthorizationResponse
PutConfigRuleRequest
PutConfigurationAggregatorRequest
PutConfigurationAggregatorResponse
PutConfigurationRecorderRequest

The input for the "PutConfigurationRecorder" action.

PutConformancePackRequest
PutConformancePackResponse
PutDeliveryChannelRequest

The input for the "PutDeliveryChannel" action.

PutEvaluationsRequest
PutEvaluationsResponse
PutExternalEvaluationRequest
PutOrganizationConfigRuleRequest
PutOrganizationConfigRuleResponse
PutOrganizationConformancePackRequest
PutOrganizationConformancePackResponse
PutRemediationConfigurationsRequest
PutRemediationConfigurationsResponse
PutRemediationExceptionsRequest
PutRemediationExceptionsResponse
PutResourceConfigRequest
PutRetentionConfigurationRequest
PutRetentionConfigurationResponse
PutStoredQueryRequest
PutStoredQueryResponse
QueryInfo

Details about the query.

RecordingGroup

Specifies the types of Amazon Web Services resource for which Config records configuration changes.

Relationship

The relationship of the related resource to the main resource.

RemediationConfiguration

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

RemediationException

An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.

RemediationExceptionResourceKey

The details that identify a resource within Config, including the resource type and resource ID.

RemediationExecutionStatus

Provides details of the current status of the invoked remediation action for that resource.

RemediationExecutionStep

Name of the step from the SSM document.

RemediationParameterValue

The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.

ResourceCount

An object that contains the resource type and the number of resources.

ResourceCountFilters

Filters the resource count based on account ID, region, and resource type.

ResourceFilters

Filters the results by resource account ID, region, resource ID, and resource name.

ResourceIdentifier

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

ResourceKey

The details that identify a resource within Config, including the resource type and resource ID.

ResourceValue

The dynamic value of the resource.

RetentionConfiguration

An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.

Scope

Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

SelectAggregateResourceConfigRequest
SelectAggregateResourceConfigResponse
SelectResourceConfigRequest
SelectResourceConfigResponse
Source

Provides the Config rule owner (Amazon Web Services or customer), the rule identifier, and the events that trigger the evaluation of your Amazon Web Services resources.

SourceDetail

Provides the source and the message 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. You can specify the parameter values for SourceDetail only for custom rules.

SsmControls

Amazon Web Services Systems Manager (SSM) specific remediation controls.

StartConfigRulesEvaluationRequest
StartConfigurationRecorderRequest

The input for the "StartConfigurationRecorder" action.

StartRemediationExecutionRequest
StartRemediationExecutionResponse
StaticValue

The static value of the resource.

StatusDetailFilters

Status filter object to filter results based on specific member account ID or status type for an organization config rule.

StopConfigurationRecorderRequest

The input for the "StopConfigurationRecorder" action.

StoredQuery

Provides the details of a stored query.

StoredQueryMetadata

Returns details of a specific query.

Tag

The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TagResourceRequest
UntagResourceRequest

§Type Aliases

AggregateConformancePackComplianceSummaryGroupKey
AggregatedSourceStatusType
AggregatedSourceType
ChronologicalOrder
ComplianceType
ConfigRuleComplianceSummaryGroupKey
ConfigRuleState
ConfigurationItemStatus
ConformancePackComplianceType
ConformancePackState
DeliveryStatus
EventSource
MaximumExecutionFrequency
MemberAccountRuleStatus
MessageType
OrganizationConfigRuleTriggerType
OrganizationResourceDetailedStatus
OrganizationResourceStatus
OrganizationRuleStatus
Owner
RecorderStatus
RemediationExecutionState
RemediationExecutionStepState
RemediationTargetType
ResourceCountGroupKey
ResourceType
ResourceValueType