Class: Aws::SecurityHub::Types::GetSoftwareResourcesV2Request

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::GetSoftwareResourcesV2Request

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Types::SoftwareFilters

  Filters the returned resources based on a set of criteria.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #next_token ⇒ String

  The token required for pagination.

• #package_name ⇒ String

  The name of the software package, for example openssl.

• #package_type ⇒ String

  The type of the software package, for example operating-system, application, or library.

• #package_version ⇒ String

  The version of the software package, for example 3.0.8.

• #scopes ⇒ Types::SoftwareScopes

  Limits the results to resources from specific organizational units or from the delegated administrator's organization.

• #sort_criteria ⇒ Array<Types::SortCriterion>

  The resource attribute used to sort the list of returned resources, for example Region or ResourceType.

Instance Attribute Details

#filters ⇒ Types::SoftwareFilters

Filters the returned resources based on a set of criteria. You can nest composite filters up to three levels deep.

Returns:

• (Types::SoftwareFilters)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return. Valid values are 1–100. The default is 100.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

A token expires one hour after it's issued. If you change the request parameters between calls, the token is no longer valid and the request fails with a ValidationException.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#package_name ⇒ String

The name of the software package, for example openssl. This value must match the PackageName returned by GetSoftwareV2.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#package_type ⇒ String

The type of the software package, for example operating-system, application, or library. This value must match the PackageType returned by GetSoftwareV2.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#package_version ⇒ String

The version of the software package, for example 3.0.8. If you omit this value, the response includes resources that contain any version of the package.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#scopes ⇒ Types::SoftwareScopes

Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.

You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

Returns:

• (Types::SoftwareScopes)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#sort_criteria ⇒ Array<Types::SortCriterion>

The resource attribute used to sort the list of returned resources, for example Region or ResourceType. You can specify one sort criterion.

Returns:

• (Array<Types::SortCriterion>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 27863

class GetSoftwareResourcesV2Request < Struct.new(
  :package_name,
  :package_type,
  :package_version,
  :filters,
  :scopes,
  :sort_criteria,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end