Class: Aws::ConfigService::Types::DescribeComplianceByResourceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-configservice/types.rb

Overview

Note:

When making an API call, you may pass DescribeComplianceByResourceRequest data as a hash:

{
  resource_type: "StringWithCharLimit256",
  resource_id: "BaseResourceId",
  compliance_types: ["COMPLIANT"], # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  limit: 1,
  next_token: "NextToken",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_types ⇒ Array<String>

Filters the results by compliance.

The allowed values are ‘COMPLIANT`, `NON_COMPLIANT`, and `INSUFFICIENT_DATA`.

Returns:

  • (Array<String>) 


2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/aws-sdk-configservice/types.rb', line 2672

class DescribeComplianceByResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :compliance_types,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The 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, AWS Config uses the default.

Returns:

  • (Integer) 


2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/aws-sdk-configservice/types.rb', line 2672

class DescribeComplianceByResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :compliance_types,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The ‘nextToken` string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

  • (String) 


2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/aws-sdk-configservice/types.rb', line 2672

class DescribeComplianceByResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :compliance_types,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

The ID of the AWS 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`.

Returns:

  • (String) 


2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/aws-sdk-configservice/types.rb', line 2672

class DescribeComplianceByResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :compliance_types,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The types of AWS resources for which you want compliance information (for example, ‘AWS::EC2::Instance`). For this action, you can specify that the resource type is an AWS account by specifying `AWS::::Account`.

Returns:

  • (String) 


2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/aws-sdk-configservice/types.rb', line 2672

class DescribeComplianceByResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :compliance_types,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end