inspector2

package module
v1.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 23, 2022 License: Apache-2.0 Imports: 35 Imported by: 26

Documentation

Overview

Package inspector2 provides the API client, operations, and parameter types for Inspector2.

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments.

Index

Constants

View Source
const ServiceAPIVersion = "2020-06-08"
View Source
const ServiceID = "Inspector2"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateMemberInput

type AssociateMemberInput struct {

	// The Amazon Web Services account ID of the member account to be associated.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

type AssociateMemberOutput

type AssociateMemberOutput struct {

	// The Amazon Web Services account ID of the successfully associated member
	// account.
	//
	// This member is required.
	AccountId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetAccountStatusInput

type BatchGetAccountStatusInput struct {

	// The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon
	// Inspector status for.
	AccountIds []string
	// contains filtered or unexported fields
}

type BatchGetAccountStatusOutput

type BatchGetAccountStatusOutput struct {

	// An array of objects that provide details on the status of Amazon Inspector for
	// each of the requested accounts.
	//
	// This member is required.
	Accounts []types.AccountState

	// An array of objects detailing any accounts that failed to enable Amazon
	// Inspector and why.
	FailedAccounts []types.FailedAccount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetFreeTrialInfoInput

type BatchGetFreeTrialInfoInput struct {

	// The account IDs to get free trial status for.
	//
	// This member is required.
	AccountIds []string
	// contains filtered or unexported fields
}

type BatchGetFreeTrialInfoOutput

type BatchGetFreeTrialInfoOutput struct {

	// An array of objects that provide Amazon Inspector free trial details for each of
	// the requested accounts.
	//
	// This member is required.
	Accounts []types.FreeTrialAccountInfo

	// An array of objects detailing any accounts that free trial data could not be
	// returned for.
	//
	// This member is required.
	FailedAccounts []types.FreeTrialInfoError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelFindingsReportInput

type CancelFindingsReportInput struct {

	// The ID of the report to be canceled.
	//
	// This member is required.
	ReportId *string
	// contains filtered or unexported fields
}

type CancelFindingsReportOutput

type CancelFindingsReportOutput struct {

	// The ID of the canceled report.
	//
	// This member is required.
	ReportId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Inspector2.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateMember

func (c *Client) AssociateMember(ctx context.Context, params *AssociateMemberInput, optFns ...func(*Options)) (*AssociateMemberOutput, error)

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.

func (*Client) BatchGetAccountStatus

func (c *Client) BatchGetAccountStatus(ctx context.Context, params *BatchGetAccountStatusInput, optFns ...func(*Options)) (*BatchGetAccountStatusOutput, error)

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

func (*Client) BatchGetFreeTrialInfo

func (c *Client) BatchGetFreeTrialInfo(ctx context.Context, params *BatchGetFreeTrialInfoInput, optFns ...func(*Options)) (*BatchGetFreeTrialInfoOutput, error)

Gets free trial status for multiple Amazon Web Services accounts.

func (*Client) CancelFindingsReport

func (c *Client) CancelFindingsReport(ctx context.Context, params *CancelFindingsReportInput, optFns ...func(*Options)) (*CancelFindingsReportOutput, error)

Cancels the given findings report.

func (*Client) CreateFilter

func (c *Client) CreateFilter(ctx context.Context, params *CreateFilterInput, optFns ...func(*Options)) (*CreateFilterOutput, error)

Creates a filter resource using specified filter criteria.

func (*Client) CreateFindingsReport

func (c *Client) CreateFindingsReport(ctx context.Context, params *CreateFindingsReportInput, optFns ...func(*Options)) (*CreateFindingsReportOutput, error)

Creates a finding report.

func (*Client) DeleteFilter

func (c *Client) DeleteFilter(ctx context.Context, params *DeleteFilterInput, optFns ...func(*Options)) (*DeleteFilterOutput, error)

Deletes a filter resource.

func (*Client) DescribeOrganizationConfiguration

func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params *DescribeOrganizationConfigurationInput, optFns ...func(*Options)) (*DescribeOrganizationConfigurationOutput, error)

Describe Amazon Inspector configuration settings for an Amazon Web Services organization

func (*Client) Disable

func (c *Client) Disable(ctx context.Context, params *DisableInput, optFns ...func(*Options)) (*DisableOutput, error)

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.

func (*Client) DisableDelegatedAdminAccount

func (c *Client) DisableDelegatedAdminAccount(ctx context.Context, params *DisableDelegatedAdminAccountInput, optFns ...func(*Options)) (*DisableDelegatedAdminAccountOutput, error)

Disables the Amazon Inspector delegated administrator for your organization.

func (*Client) DisassociateMember

func (c *Client) DisassociateMember(ctx context.Context, params *DisassociateMemberInput, optFns ...func(*Options)) (*DisassociateMemberOutput, error)

Disassociates a member account from an Amazon Inspector delegated administrator.

func (*Client) Enable

func (c *Client) Enable(ctx context.Context, params *EnableInput, optFns ...func(*Options)) (*EnableOutput, error)

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

func (*Client) EnableDelegatedAdminAccount

func (c *Client) EnableDelegatedAdminAccount(ctx context.Context, params *EnableDelegatedAdminAccountInput, optFns ...func(*Options)) (*EnableDelegatedAdminAccountOutput, error)

Enables the Amazon Inspector delegated administrator for your Organizations organization.

func (*Client) GetDelegatedAdminAccount

func (c *Client) GetDelegatedAdminAccount(ctx context.Context, params *GetDelegatedAdminAccountInput, optFns ...func(*Options)) (*GetDelegatedAdminAccountOutput, error)

Retrieves information about the Amazon Inspector delegated administrator for your organization.

func (*Client) GetFindingsReportStatus

func (c *Client) GetFindingsReportStatus(ctx context.Context, params *GetFindingsReportStatusInput, optFns ...func(*Options)) (*GetFindingsReportStatusOutput, error)

Gets the status of a findings report.

func (*Client) GetMember

func (c *Client) GetMember(ctx context.Context, params *GetMemberInput, optFns ...func(*Options)) (*GetMemberOutput, error)

Gets member information for your organization.

func (*Client) ListAccountPermissions

func (c *Client) ListAccountPermissions(ctx context.Context, params *ListAccountPermissionsInput, optFns ...func(*Options)) (*ListAccountPermissionsOutput, error)

Lists the permissions an account has to configure Amazon Inspector.

func (*Client) ListCoverage

func (c *Client) ListCoverage(ctx context.Context, params *ListCoverageInput, optFns ...func(*Options)) (*ListCoverageOutput, error)

Lists coverage details for you environment.

func (*Client) ListCoverageStatistics

func (c *Client) ListCoverageStatistics(ctx context.Context, params *ListCoverageStatisticsInput, optFns ...func(*Options)) (*ListCoverageStatisticsOutput, error)

Lists Amazon Inspector coverage statistics for your environment.

func (*Client) ListDelegatedAdminAccounts

func (c *Client) ListDelegatedAdminAccounts(ctx context.Context, params *ListDelegatedAdminAccountsInput, optFns ...func(*Options)) (*ListDelegatedAdminAccountsOutput, error)

Lists information about the Amazon Inspector delegated administrator of your organization.

func (*Client) ListFilters

func (c *Client) ListFilters(ctx context.Context, params *ListFiltersInput, optFns ...func(*Options)) (*ListFiltersOutput, error)

Lists the filters associated with your account.

func (*Client) ListFindingAggregations

func (c *Client) ListFindingAggregations(ctx context.Context, params *ListFindingAggregationsInput, optFns ...func(*Options)) (*ListFindingAggregationsOutput, error)

Lists aggregated finding data for your environment based on specific criteria.

func (*Client) ListFindings

func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, optFns ...func(*Options)) (*ListFindingsOutput, error)

Lists findings for your environment.

func (*Client) ListMembers

func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error)

List members associated with the Amazon Inspector delegated administrator for your organization.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags attached to a given resource.

func (*Client) ListUsageTotals

func (c *Client) ListUsageTotals(ctx context.Context, params *ListUsageTotalsInput, optFns ...func(*Options)) (*ListUsageTotalsOutput, error)

Lists the Amazon Inspector usage totals over the last 30 days.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to a resource.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a resource.

func (*Client) UpdateFilter

func (c *Client) UpdateFilter(ctx context.Context, params *UpdateFilterInput, optFns ...func(*Options)) (*UpdateFilterOutput, error)

Specifies the action that is to be applied to the findings that match the filter.

func (*Client) UpdateOrganizationConfiguration

func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *UpdateOrganizationConfigurationInput, optFns ...func(*Options)) (*UpdateOrganizationConfigurationOutput, error)

Updates the configurations for your Amazon Inspector organization.

type CreateFilterInput

type CreateFilterInput struct {

	// Defines the action that is to be applied to the findings that match the filter.
	//
	// This member is required.
	Action types.FilterAction

	// Defines the criteria to be used in the filter for querying findings.
	//
	// This member is required.
	FilterCriteria *types.FilterCriteria

	// The name of the filter. Minimum length of 3. Maximum length of 64. Valid
	// characters include alphanumeric characters, dot (.), underscore (_), and dash
	// (-). Spaces are not allowed.
	//
	// This member is required.
	Name *string

	// A description of the filter.
	Description *string

	// A list of tags for the filter.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFilterOutput

type CreateFilterOutput struct {

	// The Amazon Resource Number (ARN) of the successfully created filter.
	//
	// This member is required.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFindingsReportInput

type CreateFindingsReportInput struct {

	// The format to generate the report in.
	//
	// This member is required.
	ReportFormat types.ReportFormat

	// The Amazon S3 export destination for the report.
	//
	// This member is required.
	S3Destination *types.Destination

	// The filter criteria to apply to the results of the finding report.
	FilterCriteria *types.FilterCriteria
	// contains filtered or unexported fields
}

type CreateFindingsReportOutput

type CreateFindingsReportOutput struct {

	// The ID of the report.
	ReportId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFilterInput

type DeleteFilterInput struct {

	// The Amazon Resource Number (ARN) of the filter to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteFilterOutput

type DeleteFilterOutput struct {

	// The Amazon Resource Number (ARN) of the filter that has been deleted.
	//
	// This member is required.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeOrganizationConfigurationInput

type DescribeOrganizationConfigurationInput struct {
	// contains filtered or unexported fields
}

type DescribeOrganizationConfigurationOutput

type DescribeOrganizationConfigurationOutput struct {

	// The scan types are automatically enabled for new members of your organization.
	AutoEnable *types.AutoEnable

	// Represents whether your organization has reached the maximum Amazon Web Services
	// account limit for Amazon Inspector.
	MaxAccountLimitReached *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableDelegatedAdminAccountInput

type DisableDelegatedAdminAccountInput struct {

	// The Amazon Web Services account ID of the current Amazon Inspector delegated
	// administrator.
	//
	// This member is required.
	DelegatedAdminAccountId *string
	// contains filtered or unexported fields
}

type DisableDelegatedAdminAccountOutput

type DisableDelegatedAdminAccountOutput struct {

	// The Amazon Web Services account ID of the successfully disabled delegated
	// administrator.
	//
	// This member is required.
	DelegatedAdminAccountId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableInput

type DisableInput struct {

	// An array of account IDs you want to disable Amazon Inspector scans for.
	AccountIds []string

	// The resource scan types you want to disable.
	ResourceTypes []types.ResourceScanType
	// contains filtered or unexported fields
}

type DisableOutput

type DisableOutput struct {

	// Information on the accounts that have had Amazon Inspector scans successfully
	// disabled. Details are provided for each account.
	//
	// This member is required.
	Accounts []types.Account

	// Information on any accounts for which Amazon Inspector scans could not be
	// disabled. Details are provided for each account.
	FailedAccounts []types.FailedAccount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberInput

type DisassociateMemberInput struct {

	// The Amazon Web Services account ID of the member account to disassociate.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

type DisassociateMemberOutput

type DisassociateMemberOutput struct {

	// The Amazon Web Services account ID of the successfully disassociated member.
	//
	// This member is required.
	AccountId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableDelegatedAdminAccountInput

type EnableDelegatedAdminAccountInput struct {

	// The Amazon Web Services account ID of the Amazon Inspector delegated
	// administrator.
	//
	// This member is required.
	DelegatedAdminAccountId *string

	// The idempotency token for the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type EnableDelegatedAdminAccountOutput

type EnableDelegatedAdminAccountOutput struct {

	// The Amazon Web Services account ID of the successfully Amazon Inspector
	// delegated administrator.
	//
	// This member is required.
	DelegatedAdminAccountId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableInput

type EnableInput struct {

	// The resource scan types you want to enable.
	//
	// This member is required.
	ResourceTypes []types.ResourceScanType

	// A list of account IDs you want to enable Amazon Inspector scans for.
	AccountIds []string

	// The idempotency token for the request.
	ClientToken *string
	// contains filtered or unexported fields
}

type EnableOutput

type EnableOutput struct {

	// Information on the accounts that have had Amazon Inspector scans successfully
	// enabled. Details are provided for each account.
	//
	// This member is required.
	Accounts []types.Account

	// Information on any accounts for which Amazon Inspector scans could not be
	// enabled. Details are provided for each account.
	FailedAccounts []types.FailedAccount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetDelegatedAdminAccountInput

type GetDelegatedAdminAccountInput struct {
	// contains filtered or unexported fields
}

type GetDelegatedAdminAccountOutput

type GetDelegatedAdminAccountOutput struct {

	// The Amazon Web Services account ID of the Amazon Inspector delegated
	// administrator.
	DelegatedAdmin *types.DelegatedAdmin

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFindingsReportStatusInput

type GetFindingsReportStatusInput struct {

	// The ID of the report to retrieve the status of.
	ReportId *string
	// contains filtered or unexported fields
}

type GetFindingsReportStatusOutput

type GetFindingsReportStatusOutput struct {

	// The destination of the report.
	Destination *types.Destination

	// The error code of the report.
	ErrorCode types.ReportingErrorCode

	// The error message of the report.
	ErrorMessage *string

	// The filter criteria associated with the report.
	FilterCriteria *types.FilterCriteria

	// The ID of the report.
	ReportId *string

	// The status of the report.
	Status types.ExternalReportStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMemberInput

type GetMemberInput struct {

	// The Amazon Web Services account ID of the member account to retrieve information
	// on.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

type GetMemberOutput

type GetMemberOutput struct {

	// Details of the retrieved member account.
	Member *types.Member

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccountPermissionsAPIClient

type ListAccountPermissionsAPIClient interface {
	ListAccountPermissions(context.Context, *ListAccountPermissionsInput, ...func(*Options)) (*ListAccountPermissionsOutput, error)
}

ListAccountPermissionsAPIClient is a client that implements the ListAccountPermissions operation.

type ListAccountPermissionsInput

type ListAccountPermissionsInput struct {

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// The service scan type to check permissions for.
	Service types.Service
	// contains filtered or unexported fields
}

type ListAccountPermissionsOutput

type ListAccountPermissionsOutput struct {

	// Contains details on the permissions an account has to configure Amazon
	// Inspector.
	//
	// This member is required.
	Permissions []types.Permission

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAccountPermissionsPaginator

type ListAccountPermissionsPaginator struct {
	// contains filtered or unexported fields
}

ListAccountPermissionsPaginator is a paginator for ListAccountPermissions

func NewListAccountPermissionsPaginator

NewListAccountPermissionsPaginator returns a new ListAccountPermissionsPaginator

func (*ListAccountPermissionsPaginator) HasMorePages

func (p *ListAccountPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccountPermissionsPaginator) NextPage

NextPage retrieves the next ListAccountPermissions page.

type ListAccountPermissionsPaginatorOptions

type ListAccountPermissionsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAccountPermissionsPaginatorOptions is the paginator options for ListAccountPermissions

type ListCoverageAPIClient

type ListCoverageAPIClient interface {
	ListCoverage(context.Context, *ListCoverageInput, ...func(*Options)) (*ListCoverageOutput, error)
}

ListCoverageAPIClient is a client that implements the ListCoverage operation.

type ListCoverageInput

type ListCoverageInput struct {

	// An object that contains details on the filters to apply to the coverage data for
	// your environment.
	FilterCriteria *types.CoverageFilterCriteria

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCoverageOutput

type ListCoverageOutput struct {

	// An object that contains details on the covered resources in your environment.
	CoveredResources []types.CoveredResource

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCoveragePaginator

type ListCoveragePaginator struct {
	// contains filtered or unexported fields
}

ListCoveragePaginator is a paginator for ListCoverage

func NewListCoveragePaginator

func NewListCoveragePaginator(client ListCoverageAPIClient, params *ListCoverageInput, optFns ...func(*ListCoveragePaginatorOptions)) *ListCoveragePaginator

NewListCoveragePaginator returns a new ListCoveragePaginator

func (*ListCoveragePaginator) HasMorePages

func (p *ListCoveragePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCoveragePaginator) NextPage

func (p *ListCoveragePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCoverageOutput, error)

NextPage retrieves the next ListCoverage page.

type ListCoveragePaginatorOptions

type ListCoveragePaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCoveragePaginatorOptions is the paginator options for ListCoverage

type ListCoverageStatisticsAPIClient

type ListCoverageStatisticsAPIClient interface {
	ListCoverageStatistics(context.Context, *ListCoverageStatisticsInput, ...func(*Options)) (*ListCoverageStatisticsOutput, error)
}

ListCoverageStatisticsAPIClient is a client that implements the ListCoverageStatistics operation.

type ListCoverageStatisticsInput

type ListCoverageStatisticsInput struct {

	// An object that contains details on the filters to apply to the coverage data for
	// your environment.
	FilterCriteria *types.CoverageFilterCriteria

	// The value to group the results by.
	GroupBy types.GroupKey

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCoverageStatisticsOutput

type ListCoverageStatisticsOutput struct {

	// The total number for all groups.
	//
	// This member is required.
	TotalCounts *int64

	// An array with the number for each group.
	CountsByGroup []types.Counts

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCoverageStatisticsPaginator

type ListCoverageStatisticsPaginator struct {
	// contains filtered or unexported fields
}

ListCoverageStatisticsPaginator is a paginator for ListCoverageStatistics

func NewListCoverageStatisticsPaginator

NewListCoverageStatisticsPaginator returns a new ListCoverageStatisticsPaginator

func (*ListCoverageStatisticsPaginator) HasMorePages

func (p *ListCoverageStatisticsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCoverageStatisticsPaginator) NextPage

NextPage retrieves the next ListCoverageStatistics page.

type ListCoverageStatisticsPaginatorOptions

type ListCoverageStatisticsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCoverageStatisticsPaginatorOptions is the paginator options for ListCoverageStatistics

type ListDelegatedAdminAccountsAPIClient

type ListDelegatedAdminAccountsAPIClient interface {
	ListDelegatedAdminAccounts(context.Context, *ListDelegatedAdminAccountsInput, ...func(*Options)) (*ListDelegatedAdminAccountsOutput, error)
}

ListDelegatedAdminAccountsAPIClient is a client that implements the ListDelegatedAdminAccounts operation.

type ListDelegatedAdminAccountsInput

type ListDelegatedAdminAccountsInput struct {

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDelegatedAdminAccountsOutput

type ListDelegatedAdminAccountsOutput struct {

	// Details of the Amazon Inspector delegated administrator of your organization.
	DelegatedAdminAccounts []types.DelegatedAdminAccount

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDelegatedAdminAccountsPaginator

type ListDelegatedAdminAccountsPaginator struct {
	// contains filtered or unexported fields
}

ListDelegatedAdminAccountsPaginator is a paginator for ListDelegatedAdminAccounts

func NewListDelegatedAdminAccountsPaginator

NewListDelegatedAdminAccountsPaginator returns a new ListDelegatedAdminAccountsPaginator

func (*ListDelegatedAdminAccountsPaginator) HasMorePages

func (p *ListDelegatedAdminAccountsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDelegatedAdminAccountsPaginator) NextPage

NextPage retrieves the next ListDelegatedAdminAccounts page.

type ListDelegatedAdminAccountsPaginatorOptions

type ListDelegatedAdminAccountsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDelegatedAdminAccountsPaginatorOptions is the paginator options for ListDelegatedAdminAccounts

type ListFiltersAPIClient

type ListFiltersAPIClient interface {
	ListFilters(context.Context, *ListFiltersInput, ...func(*Options)) (*ListFiltersOutput, error)
}

ListFiltersAPIClient is a client that implements the ListFilters operation.

type ListFiltersInput

type ListFiltersInput struct {

	// The action the filter applies to matched findings.
	Action types.FilterAction

	// The Amazon resource number (ARN) of the filter.
	Arns []string

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFiltersOutput

type ListFiltersOutput struct {

	// Contains details on the filters associated with your account.
	//
	// This member is required.
	Filters []types.Filter

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFiltersPaginator

type ListFiltersPaginator struct {
	// contains filtered or unexported fields
}

ListFiltersPaginator is a paginator for ListFilters

func NewListFiltersPaginator

func NewListFiltersPaginator(client ListFiltersAPIClient, params *ListFiltersInput, optFns ...func(*ListFiltersPaginatorOptions)) *ListFiltersPaginator

NewListFiltersPaginator returns a new ListFiltersPaginator

func (*ListFiltersPaginator) HasMorePages

func (p *ListFiltersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFiltersPaginator) NextPage

func (p *ListFiltersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFiltersOutput, error)

NextPage retrieves the next ListFilters page.

type ListFiltersPaginatorOptions

type ListFiltersPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFiltersPaginatorOptions is the paginator options for ListFilters

type ListFindingAggregationsAPIClient

type ListFindingAggregationsAPIClient interface {
	ListFindingAggregations(context.Context, *ListFindingAggregationsInput, ...func(*Options)) (*ListFindingAggregationsOutput, error)
}

ListFindingAggregationsAPIClient is a client that implements the ListFindingAggregations operation.

type ListFindingAggregationsInput

type ListFindingAggregationsInput struct {

	// The type of the aggregation request.
	//
	// This member is required.
	AggregationType types.AggregationType

	// The Amazon Web Services account IDs to retrieve finding aggregation data for.
	AccountIds []types.StringFilter

	// Details of the aggregation request that is used to filter your aggregation
	// results.
	AggregationRequest types.AggregationRequest

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFindingAggregationsOutput

type ListFindingAggregationsOutput struct {

	// The type of aggregation to perform.
	//
	// This member is required.
	AggregationType types.AggregationType

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Objects that contain the results of an aggregation operation.
	Responses []types.AggregationResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFindingAggregationsPaginator

type ListFindingAggregationsPaginator struct {
	// contains filtered or unexported fields
}

ListFindingAggregationsPaginator is a paginator for ListFindingAggregations

func NewListFindingAggregationsPaginator

NewListFindingAggregationsPaginator returns a new ListFindingAggregationsPaginator

func (*ListFindingAggregationsPaginator) HasMorePages

func (p *ListFindingAggregationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFindingAggregationsPaginator) NextPage

NextPage retrieves the next ListFindingAggregations page.

type ListFindingAggregationsPaginatorOptions

type ListFindingAggregationsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFindingAggregationsPaginatorOptions is the paginator options for ListFindingAggregations

type ListFindingsAPIClient

type ListFindingsAPIClient interface {
	ListFindings(context.Context, *ListFindingsInput, ...func(*Options)) (*ListFindingsOutput, error)
}

ListFindingsAPIClient is a client that implements the ListFindings operation.

type ListFindingsInput

type ListFindingsInput struct {

	// Details on the filters to apply to your finding results.
	FilterCriteria *types.FilterCriteria

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Details on the sort criteria to apply to your finding results.
	SortCriteria *types.SortCriteria
	// contains filtered or unexported fields
}

type ListFindingsOutput

type ListFindingsOutput struct {

	// Contains details on the findings in your environment.
	Findings []types.Finding

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFindingsPaginator

type ListFindingsPaginator struct {
	// contains filtered or unexported fields
}

ListFindingsPaginator is a paginator for ListFindings

func NewListFindingsPaginator

func NewListFindingsPaginator(client ListFindingsAPIClient, params *ListFindingsInput, optFns ...func(*ListFindingsPaginatorOptions)) *ListFindingsPaginator

NewListFindingsPaginator returns a new ListFindingsPaginator

func (*ListFindingsPaginator) HasMorePages

func (p *ListFindingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFindingsPaginator) NextPage

func (p *ListFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFindingsOutput, error)

NextPage retrieves the next ListFindings page.

type ListFindingsPaginatorOptions

type ListFindingsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFindingsPaginatorOptions is the paginator options for ListFindings

type ListMembersAPIClient

type ListMembersAPIClient interface {
	ListMembers(context.Context, *ListMembersInput, ...func(*Options)) (*ListMembersOutput, error)
}

ListMembersAPIClient is a client that implements the ListMembers operation.

type ListMembersInput

type ListMembersInput struct {

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string

	// Specifies whether to list only currently associated members if True or to list
	// all members within the organization if False.
	OnlyAssociated *bool
	// contains filtered or unexported fields
}

type ListMembersOutput

type ListMembersOutput struct {

	// An object that contains details for each member account.
	Members []types.Member

	// The pagination parameter to be used on the next list operation to retrieve more
	// items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMembersPaginator

type ListMembersPaginator struct {
	// contains filtered or unexported fields
}

ListMembersPaginator is a paginator for ListMembers

func NewListMembersPaginator

func NewListMembersPaginator(client ListMembersAPIClient, params *ListMembersInput, optFns ...func(*ListMembersPaginatorOptions)) *ListMembersPaginator

NewListMembersPaginator returns a new ListMembersPaginator

func (*ListMembersPaginator) HasMorePages

func (p *ListMembersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMembersPaginator) NextPage

func (p *ListMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMembersOutput, error)

NextPage retrieves the next ListMembers page.

type ListMembersPaginatorOptions

type ListMembersPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMembersPaginatorOptions is the paginator options for ListMembers

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon resource number (ARN) of the resource to list tags of.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags associated with the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsageTotalsAPIClient

type ListUsageTotalsAPIClient interface {
	ListUsageTotals(context.Context, *ListUsageTotalsInput, ...func(*Options)) (*ListUsageTotalsOutput, error)
}

ListUsageTotalsAPIClient is a client that implements the ListUsageTotals operation.

type ListUsageTotalsInput

type ListUsageTotalsInput struct {

	// The Amazon Web Services account IDs to retrieve usage totals for.
	AccountIds []string

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A token to use for paginating results that are returned in the response. Set the
	// value of this parameter to null for the first request to a list action. For
	// subsequent calls, use the NextToken value returned from the previous request to
	// continue listing results after the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUsageTotalsOutput

type ListUsageTotalsOutput struct {

	// The pagination parameter to be used on the next list operation to retrieve more
	// items.
	NextToken *string

	// An object with details on the total usage for the requested account.
	Totals []types.UsageTotal

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsageTotalsPaginator

type ListUsageTotalsPaginator struct {
	// contains filtered or unexported fields
}

ListUsageTotalsPaginator is a paginator for ListUsageTotals

func NewListUsageTotalsPaginator

func NewListUsageTotalsPaginator(client ListUsageTotalsAPIClient, params *ListUsageTotalsInput, optFns ...func(*ListUsageTotalsPaginatorOptions)) *ListUsageTotalsPaginator

NewListUsageTotalsPaginator returns a new ListUsageTotalsPaginator

func (*ListUsageTotalsPaginator) HasMorePages

func (p *ListUsageTotalsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsageTotalsPaginator) NextPage

func (p *ListUsageTotalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsageTotalsOutput, error)

NextPage retrieves the next ListUsageTotals page.

type ListUsageTotalsPaginatorOptions

type ListUsageTotalsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUsageTotalsPaginatorOptions is the paginator options for ListUsageTotals

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to apply a tag to.
	//
	// This member is required.
	ResourceArn *string

	// The tags to be added to a resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource to remove tags from.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFilterInput

type UpdateFilterInput struct {

	// The Amazon Resource Number (ARN) of the filter to update.
	//
	// This member is required.
	FilterArn *string

	// Specifies the action that is to be applied to the findings that match the
	// filter.
	Action types.FilterAction

	// A description of the filter.
	Description *string

	// Defines the criteria to be update in the filter.
	FilterCriteria *types.FilterCriteria

	// The name of the filter.
	Name *string
	// contains filtered or unexported fields
}

type UpdateFilterOutput

type UpdateFilterOutput struct {

	// The Amazon Resource Number (ARN) of the successfully updated filter.
	//
	// This member is required.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateOrganizationConfigurationInput

type UpdateOrganizationConfigurationInput struct {

	// Defines which scan types are enabled automatically for new members of your
	// Amazon Inspector organization.
	//
	// This member is required.
	AutoEnable *types.AutoEnable
	// contains filtered or unexported fields
}

type UpdateOrganizationConfigurationOutput

type UpdateOrganizationConfigurationOutput struct {

	// The updated status of scan types automatically enabled for new members of your
	// Amazon Inspector organization.
	//
	// This member is required.
	AutoEnable *types.AutoEnable

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL