inspector

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 28 Imported by: 38

Documentation

Overview

Package inspector provides the API client, operations, and parameter types for Amazon Inspector.

Amazon Inspector Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_introduction.html).

Index

Constants

View Source 
const ServiceAPIVersion = "2016-02-16"
View Source 
const ServiceID = "Inspector"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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 AddAttributesToFindingsInput 

type AddAttributesToFindingsInput struct {

	// The array of attributes that you want to assign to specified findings.
	//
	// This member is required.
	Attributes []types.Attribute

	// The ARNs that specify the findings that you want to assign attributes to.
	//
	// This member is required.
	FindingArns []string
}

type AddAttributesToFindingsOutput 

type AddAttributesToFindingsOutput struct {

	// Attribute details that cannot be described. An error code is provided for each
	// failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

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

Client provides the API client to make operations call for Amazon Inspector.

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) AddAttributesToFindings 

func (c *Client) AddAttributesToFindings(ctx context.Context, params *AddAttributesToFindingsInput, optFns ...func(*Options)) (*AddAttributesToFindingsOutput, error)

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

func (*Client) CreateAssessmentTarget 

func (c *Client) CreateAssessmentTarget(ctx context.Context, params *CreateAssessmentTargetInput, optFns ...func(*Options)) (*CreateAssessmentTargetOutput, error)

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html).

func (*Client) CreateAssessmentTemplate 

func (c *Client) CreateAssessmentTemplate(ctx context.Context, params *CreateAssessmentTemplateInput, optFns ...func(*Options)) (*CreateAssessmentTemplateOutput, error)

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

func (*Client) CreateExclusionsPreview 

func (c *Client) CreateExclusionsPreview(ctx context.Context, params *CreateExclusionsPreviewInput, optFns ...func(*Options)) (*CreateExclusionsPreviewOutput, error)

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

func (*Client) CreateResourceGroup 

func (c *Client) CreateResourceGroup(ctx context.Context, params *CreateResourceGroupInput, optFns ...func(*Options)) (*CreateResourceGroupOutput, error)

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

func (*Client) DeleteAssessmentRun 

func (c *Client) DeleteAssessmentRun(ctx context.Context, params *DeleteAssessmentRunInput, optFns ...func(*Options)) (*DeleteAssessmentRunOutput, error)

Deletes the assessment run that is specified by the ARN of the assessment run.

func (*Client) DeleteAssessmentTarget 

func (c *Client) DeleteAssessmentTarget(ctx context.Context, params *DeleteAssessmentTargetInput, optFns ...func(*Options)) (*DeleteAssessmentTargetOutput, error)

Deletes the assessment target that is specified by the ARN of the assessment target.

func (*Client) DeleteAssessmentTemplate 

func (c *Client) DeleteAssessmentTemplate(ctx context.Context, params *DeleteAssessmentTemplateInput, optFns ...func(*Options)) (*DeleteAssessmentTemplateOutput, error)

Deletes the assessment template that is specified by the ARN of the assessment template.

func (*Client) DescribeAssessmentRuns 

func (c *Client) DescribeAssessmentRuns(ctx context.Context, params *DescribeAssessmentRunsInput, optFns ...func(*Options)) (*DescribeAssessmentRunsOutput, error)

Describes the assessment runs that are specified by the ARNs of the assessment runs.

func (*Client) DescribeAssessmentTargets 

func (c *Client) DescribeAssessmentTargets(ctx context.Context, params *DescribeAssessmentTargetsInput, optFns ...func(*Options)) (*DescribeAssessmentTargetsOutput, error)

Describes the assessment targets that are specified by the ARNs of the assessment targets.

func (*Client) DescribeAssessmentTemplates 

func (c *Client) DescribeAssessmentTemplates(ctx context.Context, params *DescribeAssessmentTemplatesInput, optFns ...func(*Options)) (*DescribeAssessmentTemplatesOutput, error)

Describes the assessment templates that are specified by the ARNs of the assessment templates.

func (*Client) DescribeCrossAccountAccessRole 

func (c *Client) DescribeCrossAccountAccessRole(ctx context.Context, params *DescribeCrossAccountAccessRoleInput, optFns ...func(*Options)) (*DescribeCrossAccountAccessRoleOutput, error)

Describes the IAM role that enables Amazon Inspector to access your AWS account.

func (*Client) DescribeExclusions 

func (c *Client) DescribeExclusions(ctx context.Context, params *DescribeExclusionsInput, optFns ...func(*Options)) (*DescribeExclusionsOutput, error)

Describes the exclusions that are specified by the exclusions' ARNs.

func (*Client) DescribeFindings 

func (c *Client) DescribeFindings(ctx context.Context, params *DescribeFindingsInput, optFns ...func(*Options)) (*DescribeFindingsOutput, error)

Describes the findings that are specified by the ARNs of the findings.

func (*Client) DescribeResourceGroups 

func (c *Client) DescribeResourceGroups(ctx context.Context, params *DescribeResourceGroupsInput, optFns ...func(*Options)) (*DescribeResourceGroupsOutput, error)

Describes the resource groups that are specified by the ARNs of the resource groups.

func (*Client) DescribeRulesPackages 

func (c *Client) DescribeRulesPackages(ctx context.Context, params *DescribeRulesPackagesInput, optFns ...func(*Options)) (*DescribeRulesPackagesOutput, error)

Describes the rules packages that are specified by the ARNs of the rules packages.

func (*Client) GetAssessmentReport 

func (c *Client) GetAssessmentReport(ctx context.Context, params *GetAssessmentReportInput, optFns ...func(*Options)) (*GetAssessmentReportOutput, error)

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

func (*Client) GetExclusionsPreview 

func (c *Client) GetExclusionsPreview(ctx context.Context, params *GetExclusionsPreviewInput, optFns ...func(*Options)) (*GetExclusionsPreviewOutput, error)

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

func (*Client) GetTelemetryMetadata 

func (c *Client) GetTelemetryMetadata(ctx context.Context, params *GetTelemetryMetadataInput, optFns ...func(*Options)) (*GetTelemetryMetadataOutput, error)

Information about the data that is collected for the specified assessment run.

func (*Client) ListAssessmentRunAgents 

func (c *Client) ListAssessmentRunAgents(ctx context.Context, params *ListAssessmentRunAgentsInput, optFns ...func(*Options)) (*ListAssessmentRunAgentsOutput, error)

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

func (*Client) ListAssessmentRuns 

func (c *Client) ListAssessmentRuns(ctx context.Context, params *ListAssessmentRunsInput, optFns ...func(*Options)) (*ListAssessmentRunsOutput, error)

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

func (*Client) ListAssessmentTargets 

func (c *Client) ListAssessmentTargets(ctx context.Context, params *ListAssessmentTargetsInput, optFns ...func(*Options)) (*ListAssessmentTargetsOutput, error)

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html).

func (*Client) ListAssessmentTemplates 

func (c *Client) ListAssessmentTemplates(ctx context.Context, params *ListAssessmentTemplatesInput, optFns ...func(*Options)) (*ListAssessmentTemplatesOutput, error)

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

func (*Client) ListEventSubscriptions 

func (c *Client) ListEventSubscriptions(ctx context.Context, params *ListEventSubscriptionsInput, optFns ...func(*Options)) (*ListEventSubscriptionsOutput, error)

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

func (*Client) ListExclusions 

func (c *Client) ListExclusions(ctx context.Context, params *ListExclusionsInput, optFns ...func(*Options)) (*ListExclusionsOutput, error)

List exclusions that are generated by the assessment run.

func (*Client) ListFindings 

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

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

func (*Client) ListRulesPackages 

func (c *Client) ListRulesPackages(ctx context.Context, params *ListRulesPackagesInput, optFns ...func(*Options)) (*ListRulesPackagesOutput, error)

Lists all available Amazon Inspector rules packages.

func (*Client) ListTagsForResource 

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

Lists all tags associated with an assessment template.

func (*Client) PreviewAgents 

func (c *Client) PreviewAgents(ctx context.Context, params *PreviewAgentsInput, optFns ...func(*Options)) (*PreviewAgentsOutput, error)

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

func (*Client) RegisterCrossAccountAccessRole 

func (c *Client) RegisterCrossAccountAccessRole(ctx context.Context, params *RegisterCrossAccountAccessRoleInput, optFns ...func(*Options)) (*RegisterCrossAccountAccessRoleOutput, error)

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

func (*Client) RemoveAttributesFromFindings 

func (c *Client) RemoveAttributesFromFindings(ctx context.Context, params *RemoveAttributesFromFindingsInput, optFns ...func(*Options)) (*RemoveAttributesFromFindingsOutput, error)

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

func (*Client) SetTagsForResource 

func (c *Client) SetTagsForResource(ctx context.Context, params *SetTagsForResourceInput, optFns ...func(*Options)) (*SetTagsForResourceOutput, error)

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

func (*Client) StartAssessmentRun 

func (c *Client) StartAssessmentRun(ctx context.Context, params *StartAssessmentRunInput, optFns ...func(*Options)) (*StartAssessmentRunOutput, error)

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

func (*Client) StopAssessmentRun 

func (c *Client) StopAssessmentRun(ctx context.Context, params *StopAssessmentRunInput, optFns ...func(*Options)) (*StopAssessmentRunOutput, error)

Stops the assessment run that is specified by the ARN of the assessment run.

func (*Client) SubscribeToEvent 

func (c *Client) SubscribeToEvent(ctx context.Context, params *SubscribeToEventInput, optFns ...func(*Options)) (*SubscribeToEventOutput, error)

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

func (*Client) UnsubscribeFromEvent 

func (c *Client) UnsubscribeFromEvent(ctx context.Context, params *UnsubscribeFromEventInput, optFns ...func(*Options)) (*UnsubscribeFromEventOutput, error)

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

func (*Client) UpdateAssessmentTarget 

func (c *Client) UpdateAssessmentTarget(ctx context.Context, params *UpdateAssessmentTargetInput, optFns ...func(*Options)) (*UpdateAssessmentTargetOutput, error)

Updates the assessment target that is specified by the ARN of the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

type CreateAssessmentTargetInput 

type CreateAssessmentTargetInput struct {

	// The user-defined name that identifies the assessment target that you want to
	// create. The name must be unique within the AWS account.
	//
	// This member is required.
	AssessmentTargetName *string

	// The ARN that specifies the resource group that is used to create the assessment
	// target. If resourceGroupArn is not specified, all EC2 instances in the current
	// AWS account and region are included in the assessment target.
	ResourceGroupArn *string
}

type CreateAssessmentTargetOutput 

type CreateAssessmentTargetOutput struct {

	// The ARN that specifies the assessment target that is created.
	//
	// This member is required.
	AssessmentTargetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateAssessmentTemplateInput 

type CreateAssessmentTemplateInput struct {

	// The ARN that specifies the assessment target for which you want to create the
	// assessment template.
	//
	// This member is required.
	AssessmentTargetArn *string

	// The user-defined name that identifies the assessment template that you want to
	// create. You can create several assessment templates for an assessment target.
	// The names of the assessment templates that correspond to a particular assessment
	// target must be unique.
	//
	// This member is required.
	AssessmentTemplateName *string

	// The duration of the assessment run in seconds.
	//
	// This member is required.
	DurationInSeconds int32

	// The ARNs that specify the rules packages that you want to attach to the
	// assessment template.
	//
	// This member is required.
	RulesPackageArns []string

	// The user-defined attributes that are assigned to every finding that is generated
	// by the assessment run that uses this assessment template. An attribute is a key
	// and value pair (an Attribute object). Within an assessment template, each key
	// must be unique.
	UserAttributesForFindings []types.Attribute
}

type CreateAssessmentTemplateOutput 

type CreateAssessmentTemplateOutput struct {

	// The ARN that specifies the assessment template that is created.
	//
	// This member is required.
	AssessmentTemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateExclusionsPreviewInput 

type CreateExclusionsPreviewInput struct {

	// The ARN that specifies the assessment template for which you want to create an
	// exclusions preview.
	//
	// This member is required.
	AssessmentTemplateArn *string
}

type CreateExclusionsPreviewOutput 

type CreateExclusionsPreviewOutput struct {

	// Specifies the unique identifier of the requested exclusions preview. You can use
	// the unique identifier to retrieve the exclusions preview when running the
	// GetExclusionsPreview API.
	//
	// This member is required.
	PreviewToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateResourceGroupInput 

type CreateResourceGroupInput struct {

	// A collection of keys and an array of possible values,
	// '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Value3"]}]'.
	// For example,'[{"key":"Name","values":["TestEC2Instance"]}]'.
	//
	// This member is required.
	ResourceGroupTags []types.ResourceGroupTag
}

type CreateResourceGroupOutput 

type CreateResourceGroupOutput struct {

	// The ARN that specifies the resource group that is created.
	//
	// This member is required.
	ResourceGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAssessmentRunInput 

type DeleteAssessmentRunInput struct {

	// The ARN that specifies the assessment run that you want to delete.
	//
	// This member is required.
	AssessmentRunArn *string
}

type DeleteAssessmentRunOutput 

type DeleteAssessmentRunOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAssessmentTargetInput 

type DeleteAssessmentTargetInput struct {

	// The ARN that specifies the assessment target that you want to delete.
	//
	// This member is required.
	AssessmentTargetArn *string
}

type DeleteAssessmentTargetOutput 

type DeleteAssessmentTargetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAssessmentTemplateInput 

type DeleteAssessmentTemplateInput struct {

	// The ARN that specifies the assessment template that you want to delete.
	//
	// This member is required.
	AssessmentTemplateArn *string
}

type DeleteAssessmentTemplateOutput 

type DeleteAssessmentTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAssessmentRunsInput 

type DescribeAssessmentRunsInput struct {

	// The ARN that specifies the assessment run that you want to describe.
	//
	// This member is required.
	AssessmentRunArns []string
}

type DescribeAssessmentRunsOutput 

type DescribeAssessmentRunsOutput struct {

	// Information about the assessment run.
	//
	// This member is required.
	AssessmentRuns []types.AssessmentRun

	// Assessment run details that cannot be described. An error code is provided for
	// each failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAssessmentTargetsInput 

type DescribeAssessmentTargetsInput struct {

	// The ARNs that specifies the assessment targets that you want to describe.
	//
	// This member is required.
	AssessmentTargetArns []string
}

type DescribeAssessmentTargetsOutput 

type DescribeAssessmentTargetsOutput struct {

	// Information about the assessment targets.
	//
	// This member is required.
	AssessmentTargets []types.AssessmentTarget

	// Assessment target details that cannot be described. An error code is provided
	// for each failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAssessmentTemplatesInput 

type DescribeAssessmentTemplatesInput struct {

	// This member is required.
	AssessmentTemplateArns []string
}

type DescribeAssessmentTemplatesOutput 

type DescribeAssessmentTemplatesOutput struct {

	// Information about the assessment templates.
	//
	// This member is required.
	AssessmentTemplates []types.AssessmentTemplate

	// Assessment template details that cannot be described. An error code is provided
	// for each failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeCrossAccountAccessRoleInput 

type DescribeCrossAccountAccessRoleInput struct {
}

type DescribeCrossAccountAccessRoleOutput 

type DescribeCrossAccountAccessRoleOutput struct {

	// The date when the cross-account access role was registered.
	//
	// This member is required.
	RegisteredAt *time.Time

	// The ARN that specifies the IAM role that Amazon Inspector uses to access your
	// AWS account.
	//
	// This member is required.
	RoleArn *string

	// A Boolean value that specifies whether the IAM role has the necessary policies
	// attached to enable Amazon Inspector to access your AWS account.
	//
	// This member is required.
	Valid *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeExclusionsInput 

type DescribeExclusionsInput struct {

	// The list of ARNs that specify the exclusions that you want to describe.
	//
	// This member is required.
	ExclusionArns []string

	// The locale into which you want to translate the exclusion's title, description,
	// and recommendation.
	Locale types.Locale
}

type DescribeExclusionsOutput 

type DescribeExclusionsOutput struct {

	// Information about the exclusions.
	//
	// This member is required.
	Exclusions map[string]types.Exclusion

	// Exclusion details that cannot be described. An error code is provided for each
	// failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeFindingsInput 

type DescribeFindingsInput struct {

	// The ARN that specifies the finding that you want to describe.
	//
	// This member is required.
	FindingArns []string

	// The locale into which you want to translate a finding description,
	// recommendation, and the short description that identifies the finding.
	Locale types.Locale
}

type DescribeFindingsOutput 

type DescribeFindingsOutput struct {

	// Finding details that cannot be described. An error code is provided for each
	// failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Information about the finding.
	//
	// This member is required.
	Findings []types.Finding

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeResourceGroupsInput 

type DescribeResourceGroupsInput struct {

	// The ARN that specifies the resource group that you want to describe.
	//
	// This member is required.
	ResourceGroupArns []string
}

type DescribeResourceGroupsOutput 

type DescribeResourceGroupsOutput struct {

	// Resource group details that cannot be described. An error code is provided for
	// each failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Information about a resource group.
	//
	// This member is required.
	ResourceGroups []types.ResourceGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRulesPackagesInput 

type DescribeRulesPackagesInput struct {

	// The ARN that specifies the rules package that you want to describe.
	//
	// This member is required.
	RulesPackageArns []string

	// The locale that you want to translate a rules package description into.
	Locale types.Locale
}

type DescribeRulesPackagesOutput 

type DescribeRulesPackagesOutput struct {

	// Rules package details that cannot be described. An error code is provided for
	// each failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Information about the rules package.
	//
	// This member is required.
	RulesPackages []types.RulesPackage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetAssessmentReportInput 

type GetAssessmentReportInput struct {

	// The ARN that specifies the assessment run for which you want to generate a
	// report.
	//
	// This member is required.
	AssessmentRunArn *string

	// Specifies the file format (html or pdf) of the assessment report that you want
	// to generate.
	//
	// This member is required.
	ReportFileFormat types.ReportFileFormat

	// Specifies the type of the assessment report that you want to generate. There are
	// two types of assessment reports: a finding report and a full report. For more
	// information, see Assessment Reports
	// (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html).
	//
	// This member is required.
	ReportType types.ReportType
}

type GetAssessmentReportOutput 

type GetAssessmentReportOutput struct {

	// Specifies the status of the request to generate an assessment report.
	//
	// This member is required.
	Status types.ReportStatus

	// Specifies the URL where you can find the generated assessment report. This
	// parameter is only returned if the report is successfully generated.
	Url *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetExclusionsPreviewAPIClient added in v0.30.0 

type GetExclusionsPreviewAPIClient interface {
	GetExclusionsPreview(context.Context, *GetExclusionsPreviewInput, ...func(*Options)) (*GetExclusionsPreviewOutput, error)
}

GetExclusionsPreviewAPIClient is a client that implements the GetExclusionsPreview operation.

type GetExclusionsPreviewInput 

type GetExclusionsPreviewInput struct {

	// The ARN that specifies the assessment template for which the exclusions preview
	// was requested.
	//
	// This member is required.
	AssessmentTemplateArn *string

	// The unique identifier associated of the exclusions preview.
	//
	// This member is required.
	PreviewToken *string

	// The locale into which you want to translate the exclusion's title, description,
	// and recommendation.
	Locale types.Locale

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 100. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the GetExclusionsPreviewRequest action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// nextToken from the previous response to continue listing data.
	NextToken *string
}

type GetExclusionsPreviewOutput 

type GetExclusionsPreviewOutput struct {

	// Specifies the status of the request to generate an exclusions preview.
	//
	// This member is required.
	PreviewStatus types.PreviewStatus

	// Information about the exclusions included in the preview.
	ExclusionPreviews []types.ExclusionPreview

	// When a response is generated, if there is more data to be listed, this
	// parameters is present in the response and contains the value to use for the
	// nextToken parameter in a subsequent pagination request. If there is no more data
	// to be listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetExclusionsPreviewPaginator added in v0.30.0 

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

GetExclusionsPreviewPaginator is a paginator for GetExclusionsPreview

func NewGetExclusionsPreviewPaginator added in v0.30.0 

func NewGetExclusionsPreviewPaginator(client GetExclusionsPreviewAPIClient, params *GetExclusionsPreviewInput, optFns ...func(*GetExclusionsPreviewPaginatorOptions)) *GetExclusionsPreviewPaginator

NewGetExclusionsPreviewPaginator returns a new GetExclusionsPreviewPaginator

func (*GetExclusionsPreviewPaginator) HasMorePages added in v0.30.0 

func (p *GetExclusionsPreviewPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetExclusionsPreviewPaginator) NextPage added in v0.30.0 

func (p *GetExclusionsPreviewPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetExclusionsPreviewOutput, error)

NextPage retrieves the next GetExclusionsPreview page.

type GetExclusionsPreviewPaginatorOptions added in v0.30.0 

type GetExclusionsPreviewPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 100. The maximum value is 500.
	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
}

GetExclusionsPreviewPaginatorOptions is the paginator options for GetExclusionsPreview

type GetTelemetryMetadataInput 

type GetTelemetryMetadataInput struct {

	// The ARN that specifies the assessment run that has the telemetry data that you
	// want to obtain.
	//
	// This member is required.
	AssessmentRunArn *string
}

type GetTelemetryMetadataOutput 

type GetTelemetryMetadataOutput struct {

	// Telemetry details.
	//
	// This member is required.
	TelemetryMetadata []types.TelemetryMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 ListAssessmentRunAgentsAPIClient added in v0.30.0 

type ListAssessmentRunAgentsAPIClient interface {
	ListAssessmentRunAgents(context.Context, *ListAssessmentRunAgentsInput, ...func(*Options)) (*ListAssessmentRunAgentsOutput, error)
}

ListAssessmentRunAgentsAPIClient is a client that implements the ListAssessmentRunAgents operation.

type ListAssessmentRunAgentsInput 

type ListAssessmentRunAgentsInput struct {

	// The ARN that specifies the assessment run whose agents you want to list.
	//
	// This member is required.
	AssessmentRunArn *string

	// You can use this parameter to specify a subset of data to be included in the
	// action's response. For a record to match a filter, all specified filter
	// attributes must match. When multiple values are specified for a filter
	// attribute, any of the values can match.
	Filter *types.AgentFilter

	// You can use this parameter to indicate the maximum number of items that you want
	// in the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListAssessmentRunAgents action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// NextToken from the previous response to continue listing data.
	NextToken *string
}

type ListAssessmentRunAgentsOutput 

type ListAssessmentRunAgentsOutput struct {

	// A list of ARNs that specifies the agents returned by the action.
	//
	// This member is required.
	AssessmentRunAgents []types.AssessmentRunAgent

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAssessmentRunAgentsPaginator added in v0.30.0 

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

ListAssessmentRunAgentsPaginator is a paginator for ListAssessmentRunAgents

func NewListAssessmentRunAgentsPaginator added in v0.30.0 

func NewListAssessmentRunAgentsPaginator(client ListAssessmentRunAgentsAPIClient, params *ListAssessmentRunAgentsInput, optFns ...func(*ListAssessmentRunAgentsPaginatorOptions)) *ListAssessmentRunAgentsPaginator

NewListAssessmentRunAgentsPaginator returns a new ListAssessmentRunAgentsPaginator

func (*ListAssessmentRunAgentsPaginator) HasMorePages added in v0.30.0 

func (p *ListAssessmentRunAgentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentRunAgentsPaginator) NextPage added in v0.30.0 

func (p *ListAssessmentRunAgentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssessmentRunAgentsOutput, error)

NextPage retrieves the next ListAssessmentRunAgents page.

type ListAssessmentRunAgentsPaginatorOptions added in v0.30.0 

type ListAssessmentRunAgentsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items that you want
	// in the response. The default value is 10. The maximum value is 500.
	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
}

ListAssessmentRunAgentsPaginatorOptions is the paginator options for ListAssessmentRunAgents

type ListAssessmentRunsAPIClient added in v0.30.0 

type ListAssessmentRunsAPIClient interface {
	ListAssessmentRuns(context.Context, *ListAssessmentRunsInput, ...func(*Options)) (*ListAssessmentRunsOutput, error)
}

ListAssessmentRunsAPIClient is a client that implements the ListAssessmentRuns operation.

type ListAssessmentRunsInput 

type ListAssessmentRunsInput struct {

	// The ARNs that specify the assessment templates whose assessment runs you want to
	// list.
	AssessmentTemplateArns []string

	// You can use this parameter to specify a subset of data to be included in the
	// action's response. For a record to match a filter, all specified filter
	// attributes must match. When multiple values are specified for a filter
	// attribute, any of the values can match.
	Filter *types.AssessmentRunFilter

	// You can use this parameter to indicate the maximum number of items that you want
	// in the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListAssessmentRuns action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// NextToken from the previous response to continue listing data.
	NextToken *string
}

type ListAssessmentRunsOutput 

type ListAssessmentRunsOutput struct {

	// A list of ARNs that specifies the assessment runs that are returned by the
	// action.
	//
	// This member is required.
	AssessmentRunArns []string

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAssessmentRunsPaginator added in v0.30.0 

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

ListAssessmentRunsPaginator is a paginator for ListAssessmentRuns

func NewListAssessmentRunsPaginator added in v0.30.0 

func NewListAssessmentRunsPaginator(client ListAssessmentRunsAPIClient, params *ListAssessmentRunsInput, optFns ...func(*ListAssessmentRunsPaginatorOptions)) *ListAssessmentRunsPaginator

NewListAssessmentRunsPaginator returns a new ListAssessmentRunsPaginator

func (*ListAssessmentRunsPaginator) HasMorePages added in v0.30.0 

func (p *ListAssessmentRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentRunsPaginator) NextPage added in v0.30.0 

func (p *ListAssessmentRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssessmentRunsOutput, error)

NextPage retrieves the next ListAssessmentRuns page.

type ListAssessmentRunsPaginatorOptions added in v0.30.0 

type ListAssessmentRunsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items that you want
	// in the response. The default value is 10. The maximum value is 500.
	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
}

ListAssessmentRunsPaginatorOptions is the paginator options for ListAssessmentRuns

type ListAssessmentTargetsAPIClient added in v0.30.0 

type ListAssessmentTargetsAPIClient interface {
	ListAssessmentTargets(context.Context, *ListAssessmentTargetsInput, ...func(*Options)) (*ListAssessmentTargetsOutput, error)
}

ListAssessmentTargetsAPIClient is a client that implements the ListAssessmentTargets operation.

type ListAssessmentTargetsInput 

type ListAssessmentTargetsInput struct {

	// You can use this parameter to specify a subset of data to be included in the
	// action's response. For a record to match a filter, all specified filter
	// attributes must match. When multiple values are specified for a filter
	// attribute, any of the values can match.
	Filter *types.AssessmentTargetFilter

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListAssessmentTargets action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// NextToken from the previous response to continue listing data.
	NextToken *string
}

type ListAssessmentTargetsOutput 

type ListAssessmentTargetsOutput struct {

	// A list of ARNs that specifies the assessment targets that are returned by the
	// action.
	//
	// This member is required.
	AssessmentTargetArns []string

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAssessmentTargetsPaginator added in v0.30.0 

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

ListAssessmentTargetsPaginator is a paginator for ListAssessmentTargets

func NewListAssessmentTargetsPaginator added in v0.30.0 

func NewListAssessmentTargetsPaginator(client ListAssessmentTargetsAPIClient, params *ListAssessmentTargetsInput, optFns ...func(*ListAssessmentTargetsPaginatorOptions)) *ListAssessmentTargetsPaginator

NewListAssessmentTargetsPaginator returns a new ListAssessmentTargetsPaginator

func (*ListAssessmentTargetsPaginator) HasMorePages added in v0.30.0 

func (p *ListAssessmentTargetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentTargetsPaginator) NextPage added in v0.30.0 

func (p *ListAssessmentTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssessmentTargetsOutput, error)

NextPage retrieves the next ListAssessmentTargets page.

type ListAssessmentTargetsPaginatorOptions added in v0.30.0 

type ListAssessmentTargetsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	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
}

ListAssessmentTargetsPaginatorOptions is the paginator options for ListAssessmentTargets

type ListAssessmentTemplatesAPIClient added in v0.30.0 

type ListAssessmentTemplatesAPIClient interface {
	ListAssessmentTemplates(context.Context, *ListAssessmentTemplatesInput, ...func(*Options)) (*ListAssessmentTemplatesOutput, error)
}

ListAssessmentTemplatesAPIClient is a client that implements the ListAssessmentTemplates operation.

type ListAssessmentTemplatesInput 

type ListAssessmentTemplatesInput struct {

	// A list of ARNs that specifies the assessment targets whose assessment templates
	// you want to list.
	AssessmentTargetArns []string

	// You can use this parameter to specify a subset of data to be included in the
	// action's response. For a record to match a filter, all specified filter
	// attributes must match. When multiple values are specified for a filter
	// attribute, any of the values can match.
	Filter *types.AssessmentTemplateFilter

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListAssessmentTemplates action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// NextToken from the previous response to continue listing data.
	NextToken *string
}

type ListAssessmentTemplatesOutput 

type ListAssessmentTemplatesOutput struct {

	// A list of ARNs that specifies the assessment templates returned by the action.
	//
	// This member is required.
	AssessmentTemplateArns []string

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAssessmentTemplatesPaginator added in v0.30.0 

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

ListAssessmentTemplatesPaginator is a paginator for ListAssessmentTemplates

func NewListAssessmentTemplatesPaginator added in v0.30.0 

func NewListAssessmentTemplatesPaginator(client ListAssessmentTemplatesAPIClient, params *ListAssessmentTemplatesInput, optFns ...func(*ListAssessmentTemplatesPaginatorOptions)) *ListAssessmentTemplatesPaginator

NewListAssessmentTemplatesPaginator returns a new ListAssessmentTemplatesPaginator

func (*ListAssessmentTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *ListAssessmentTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentTemplatesPaginator) NextPage added in v0.30.0 

func (p *ListAssessmentTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssessmentTemplatesOutput, error)

NextPage retrieves the next ListAssessmentTemplates page.

type ListAssessmentTemplatesPaginatorOptions added in v0.30.0 

type ListAssessmentTemplatesPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	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
}

ListAssessmentTemplatesPaginatorOptions is the paginator options for ListAssessmentTemplates

type ListEventSubscriptionsAPIClient added in v0.30.0 

type ListEventSubscriptionsAPIClient interface {
	ListEventSubscriptions(context.Context, *ListEventSubscriptionsInput, ...func(*Options)) (*ListEventSubscriptionsOutput, error)
}

ListEventSubscriptionsAPIClient is a client that implements the ListEventSubscriptions operation.

type ListEventSubscriptionsInput 

type ListEventSubscriptionsInput struct {

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListEventSubscriptions action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// NextToken from the previous response to continue listing data.
	NextToken *string

	// The ARN of the assessment template for which you want to list the existing event
	// subscriptions.
	ResourceArn *string
}

type ListEventSubscriptionsOutput 

type ListEventSubscriptionsOutput struct {

	// Details of the returned event subscriptions.
	//
	// This member is required.
	Subscriptions []types.Subscription

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListEventSubscriptionsPaginator added in v0.30.0 

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

ListEventSubscriptionsPaginator is a paginator for ListEventSubscriptions

func NewListEventSubscriptionsPaginator added in v0.30.0 

func NewListEventSubscriptionsPaginator(client ListEventSubscriptionsAPIClient, params *ListEventSubscriptionsInput, optFns ...func(*ListEventSubscriptionsPaginatorOptions)) *ListEventSubscriptionsPaginator

NewListEventSubscriptionsPaginator returns a new ListEventSubscriptionsPaginator

func (*ListEventSubscriptionsPaginator) HasMorePages added in v0.30.0 

func (p *ListEventSubscriptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventSubscriptionsPaginator) NextPage added in v0.30.0 

func (p *ListEventSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventSubscriptionsOutput, error)

NextPage retrieves the next ListEventSubscriptions page.

type ListEventSubscriptionsPaginatorOptions added in v0.30.0 

type ListEventSubscriptionsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	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
}

ListEventSubscriptionsPaginatorOptions is the paginator options for ListEventSubscriptions

type ListExclusionsAPIClient added in v0.30.0 

type ListExclusionsAPIClient interface {
	ListExclusions(context.Context, *ListExclusionsInput, ...func(*Options)) (*ListExclusionsOutput, error)
}

ListExclusionsAPIClient is a client that implements the ListExclusions operation.

type ListExclusionsInput 

type ListExclusionsInput struct {

	// The ARN of the assessment run that generated the exclusions that you want to
	// list.
	//
	// This member is required.
	AssessmentRunArn *string

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 100. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListExclusionsRequest action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// nextToken from the previous response to continue listing data.
	NextToken *string
}

type ListExclusionsOutput 

type ListExclusionsOutput struct {

	// A list of exclusions' ARNs returned by the action.
	//
	// This member is required.
	ExclusionArns []string

	// When a response is generated, if there is more data to be listed, this
	// parameters is present in the response and contains the value to use for the
	// nextToken parameter in a subsequent pagination request. If there is no more data
	// to be listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListExclusionsPaginator added in v0.30.0 

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

ListExclusionsPaginator is a paginator for ListExclusions

func NewListExclusionsPaginator added in v0.30.0 

func NewListExclusionsPaginator(client ListExclusionsAPIClient, params *ListExclusionsInput, optFns ...func(*ListExclusionsPaginatorOptions)) *ListExclusionsPaginator

NewListExclusionsPaginator returns a new ListExclusionsPaginator

func (*ListExclusionsPaginator) HasMorePages added in v0.30.0 

func (p *ListExclusionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExclusionsPaginator) NextPage added in v0.30.0 

func (p *ListExclusionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExclusionsOutput, error)

NextPage retrieves the next ListExclusions page.

type ListExclusionsPaginatorOptions added in v0.30.0 

type ListExclusionsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 100. The maximum value is 500.
	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
}

ListExclusionsPaginatorOptions is the paginator options for ListExclusions

type ListFindingsAPIClient added in v0.30.0 

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 {

	// The ARNs of the assessment runs that generate the findings that you want to
	// list.
	AssessmentRunArns []string

	// You can use this parameter to specify a subset of data to be included in the
	// action's response. For a record to match a filter, all specified filter
	// attributes must match. When multiple values are specified for a filter
	// attribute, any of the values can match.
	Filter *types.FindingFilter

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListFindings action. Subsequent
	// calls to the action fill nextToken in the request with the value of NextToken
	// from the previous response to continue listing data.
	NextToken *string
}

type ListFindingsOutput 

type ListFindingsOutput struct {

	// A list of ARNs that specifies the findings returned by the action.
	//
	// This member is required.
	FindingArns []string

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListFindingsPaginator added in v0.30.0 

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

ListFindingsPaginator is a paginator for ListFindings

func NewListFindingsPaginator added in v0.30.0 

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

NewListFindingsPaginator returns a new ListFindingsPaginator

func (*ListFindingsPaginator) HasMorePages added in v0.30.0 

func (p *ListFindingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFindingsPaginator) NextPage added in v0.30.0 

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

NextPage retrieves the next ListFindings page.

type ListFindingsPaginatorOptions added in v0.30.0 

type ListFindingsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	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 ListRulesPackagesAPIClient added in v0.30.0 

type ListRulesPackagesAPIClient interface {
	ListRulesPackages(context.Context, *ListRulesPackagesInput, ...func(*Options)) (*ListRulesPackagesOutput, error)
}

ListRulesPackagesAPIClient is a client that implements the ListRulesPackages operation.

type ListRulesPackagesInput 

type ListRulesPackagesInput struct {

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the ListRulesPackages action. Subsequent
	// calls to the action fill nextToken in the request with the value of NextToken
	// from the previous response to continue listing data.
	NextToken *string
}

type ListRulesPackagesOutput 

type ListRulesPackagesOutput struct {

	// The list of ARNs that specifies the rules packages returned by the action.
	//
	// This member is required.
	RulesPackageArns []string

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListRulesPackagesPaginator added in v0.30.0 

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

ListRulesPackagesPaginator is a paginator for ListRulesPackages

func NewListRulesPackagesPaginator added in v0.30.0 

func NewListRulesPackagesPaginator(client ListRulesPackagesAPIClient, params *ListRulesPackagesInput, optFns ...func(*ListRulesPackagesPaginatorOptions)) *ListRulesPackagesPaginator

NewListRulesPackagesPaginator returns a new ListRulesPackagesPaginator

func (*ListRulesPackagesPaginator) HasMorePages added in v0.30.0 

func (p *ListRulesPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRulesPackagesPaginator) NextPage added in v0.30.0 

func (p *ListRulesPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRulesPackagesOutput, error)

NextPage retrieves the next ListRulesPackages page.

type ListRulesPackagesPaginatorOptions added in v0.30.0 

type ListRulesPackagesPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	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
}

ListRulesPackagesPaginatorOptions is the paginator options for ListRulesPackages

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN that specifies the assessment template whose tags you want to list.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A collection of key and value pairs.
	//
	// This member is required.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 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

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

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

type PreviewAgentsAPIClient added in v0.30.0 

type PreviewAgentsAPIClient interface {
	PreviewAgents(context.Context, *PreviewAgentsInput, ...func(*Options)) (*PreviewAgentsOutput, error)
}

PreviewAgentsAPIClient is a client that implements the PreviewAgents operation.

type PreviewAgentsInput 

type PreviewAgentsInput struct {

	// The ARN of the assessment target whose agents you want to preview.
	//
	// This member is required.
	PreviewAgentsArn *string

	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	MaxResults *int32

	// You can use this parameter when paginating results. Set the value of this
	// parameter to null on your first call to the PreviewAgents action. Subsequent
	// calls to the action fill nextToken in the request with the value of NextToken
	// from the previous response to continue listing data.
	NextToken *string
}

type PreviewAgentsOutput 

type PreviewAgentsOutput struct {

	// The resulting list of agents.
	//
	// This member is required.
	AgentPreviews []types.AgentPreview

	// When a response is generated, if there is more data to be listed, this parameter
	// is present in the response and contains the value to use for the nextToken
	// parameter in a subsequent pagination request. If there is no more data to be
	// listed, this parameter is set to null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PreviewAgentsPaginator added in v0.30.0 

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

PreviewAgentsPaginator is a paginator for PreviewAgents

func NewPreviewAgentsPaginator added in v0.30.0 

func NewPreviewAgentsPaginator(client PreviewAgentsAPIClient, params *PreviewAgentsInput, optFns ...func(*PreviewAgentsPaginatorOptions)) *PreviewAgentsPaginator

NewPreviewAgentsPaginator returns a new PreviewAgentsPaginator

func (*PreviewAgentsPaginator) HasMorePages added in v0.30.0 

func (p *PreviewAgentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*PreviewAgentsPaginator) NextPage added in v0.30.0 

func (p *PreviewAgentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*PreviewAgentsOutput, error)

NextPage retrieves the next PreviewAgents page.

type PreviewAgentsPaginatorOptions added in v0.30.0 

type PreviewAgentsPaginatorOptions struct {
	// You can use this parameter to indicate the maximum number of items you want in
	// the response. The default value is 10. The maximum value is 500.
	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
}

PreviewAgentsPaginatorOptions is the paginator options for PreviewAgents

type RegisterCrossAccountAccessRoleInput 

type RegisterCrossAccountAccessRoleInput struct {

	// The ARN of the IAM role that grants Amazon Inspector access to AWS Services
	// needed to perform security assessments.
	//
	// This member is required.
	RoleArn *string
}

type RegisterCrossAccountAccessRoleOutput 

type RegisterCrossAccountAccessRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveAttributesFromFindingsInput 

type RemoveAttributesFromFindingsInput struct {

	// The array of attribute keys that you want to remove from specified findings.
	//
	// This member is required.
	AttributeKeys []string

	// The ARNs that specify the findings that you want to remove attributes from.
	//
	// This member is required.
	FindingArns []string
}

type RemoveAttributesFromFindingsOutput 

type RemoveAttributesFromFindingsOutput struct {

	// Attributes details that cannot be described. An error code is provided for each
	// failed item.
	//
	// This member is required.
	FailedItems map[string]types.FailedItemDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SetTagsForResourceInput 

type SetTagsForResourceInput struct {

	// The ARN of the assessment template that you want to set tags to.
	//
	// This member is required.
	ResourceArn *string

	// A collection of key and value pairs that you want to set to the assessment
	// template.
	Tags []types.Tag
}

type SetTagsForResourceOutput 

type SetTagsForResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartAssessmentRunInput 

type StartAssessmentRunInput struct {

	// The ARN of the assessment template of the assessment run that you want to start.
	//
	// This member is required.
	AssessmentTemplateArn *string

	// You can specify the name for the assessment run. The name must be unique for the
	// assessment template whose ARN is used to start the assessment run.
	AssessmentRunName *string
}

type StartAssessmentRunOutput 

type StartAssessmentRunOutput struct {

	// The ARN of the assessment run that has been started.
	//
	// This member is required.
	AssessmentRunArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopAssessmentRunInput 

type StopAssessmentRunInput struct {

	// The ARN of the assessment run that you want to stop.
	//
	// This member is required.
	AssessmentRunArn *string

	// An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.
	// START_EVALUATION (the default value), stops the AWS agent from collecting data
	// and begins the results evaluation and the findings generation process.
	// SKIP_EVALUATION cancels the assessment run immediately, after which no findings
	// are generated.
	StopAction types.StopAction
}

type StopAssessmentRunOutput 

type StopAssessmentRunOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SubscribeToEventInput 

type SubscribeToEventInput struct {

	// The event for which you want to receive SNS notifications.
	//
	// This member is required.
	Event types.InspectorEvent

	// The ARN of the assessment template that is used during the event for which you
	// want to receive SNS notifications.
	//
	// This member is required.
	ResourceArn *string

	// The ARN of the SNS topic to which the SNS notifications are sent.
	//
	// This member is required.
	TopicArn *string
}

type SubscribeToEventOutput 

type SubscribeToEventOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UnsubscribeFromEventInput 

type UnsubscribeFromEventInput struct {

	// The event for which you want to stop receiving SNS notifications.
	//
	// This member is required.
	Event types.InspectorEvent

	// The ARN of the assessment template that is used during the event for which you
	// want to stop receiving SNS notifications.
	//
	// This member is required.
	ResourceArn *string

	// The ARN of the SNS topic to which SNS notifications are sent.
	//
	// This member is required.
	TopicArn *string
}

type UnsubscribeFromEventOutput 

type UnsubscribeFromEventOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAssessmentTargetInput 

type UpdateAssessmentTargetInput struct {

	// The ARN of the assessment target that you want to update.
	//
	// This member is required.
	AssessmentTargetArn *string

	// The name of the assessment target that you want to update.
	//
	// This member is required.
	AssessmentTargetName *string

	// The ARN of the resource group that is used to specify the new resource group to
	// associate with the assessment target.
	ResourceGroupArn *string
}

type UpdateAssessmentTargetOutput 

type UpdateAssessmentTargetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.