You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_typesArray<String>

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

Returns:

  • (Array<String>)


1054
1055
1056
1057
1058
1059
1060
1061
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1054

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

#limitInteger

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

Returns:

  • (Integer)


1054
1055
1056
1057
1058
1059
1060
1061
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1054

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

#next_tokenString

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

Returns:

  • (String)


1054
1055
1056
1057
1058
1059
1060
1061
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1054

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

#resource_idString

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)


1054
1055
1056
1057
1058
1059
1060
1061
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1054

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

#resource_typeString

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)


1054
1055
1056
1057
1058
1059
1060
1061
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1054

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