inspector

package module
v0.26.0 Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AddAttributesToFindingsInput

type AddAttributesToFindingsInput struct {
	// The ARNs that specify the findings that you want to assign attributes to.
	FindingArns []*string
	// The array of attributes that you want to assign to specified findings.
	Attributes []*types.Attribute
}

type AddAttributesToFindingsOutput

type AddAttributesToFindingsOutput struct {
	// Attribute details that cannot be described. An error code is provided for each
	// failed item.
	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
}

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

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 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
	// The user-defined name that identifies the assessment target that you want to
	// create. The name must be unique within the AWS account.
	AssessmentTargetName *string
}

type CreateAssessmentTargetOutput

type CreateAssessmentTargetOutput struct {
	// The ARN that specifies the assessment target that is created.
	AssessmentTargetArn *string

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

type CreateAssessmentTemplateInput

type CreateAssessmentTemplateInput struct {
	// The ARNs that specify the rules packages that you want to attach to the
	// assessment template.
	RulesPackageArns []*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.
	AssessmentTemplateName *string
	// The ARN that specifies the assessment target for which you want to create the
	// assessment template.
	AssessmentTargetArn *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
	// The duration of the assessment run in seconds.
	DurationInSeconds *int32
}

type CreateAssessmentTemplateOutput

type CreateAssessmentTemplateOutput struct {
	// The ARN that specifies the assessment template that is created.
	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.
	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.
	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"]}]'.
	ResourceGroupTags []*types.ResourceGroupTag
}

type CreateResourceGroupOutput

type CreateResourceGroupOutput struct {
	// The ARN that specifies the resource group that is created.
	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.
	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.
	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.
	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.
	AssessmentRunArns []*string
}

type DescribeAssessmentRunsOutput

type DescribeAssessmentRunsOutput struct {
	// Information about the assessment run.
	AssessmentRuns []*types.AssessmentRun
	// Assessment run details that cannot be described. An error code is provided for
	// each failed item.
	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.
	AssessmentTargetArns []*string
}

type DescribeAssessmentTargetsOutput

type DescribeAssessmentTargetsOutput struct {
	// Assessment target details that cannot be described. An error code is provided
	// for each failed item.
	FailedItems map[string]*types.FailedItemDetails
	// Information about the assessment targets.
	AssessmentTargets []*types.AssessmentTarget

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

type DescribeAssessmentTemplatesInput

type DescribeAssessmentTemplatesInput struct {
	AssessmentTemplateArns []*string
}

type DescribeAssessmentTemplatesOutput

type DescribeAssessmentTemplatesOutput struct {
	// Information about the assessment templates.
	AssessmentTemplates []*types.AssessmentTemplate
	// Assessment template details that cannot be described. An error code is provided
	// for each failed item.
	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 {
	// A Boolean value that specifies whether the IAM role has the necessary policies
	// attached to enable Amazon Inspector to access your AWS account.
	Valid *bool
	// The ARN that specifies the IAM role that Amazon Inspector uses to access your
	// AWS account.
	RoleArn *string
	// The date when the cross-account access role was registered.
	RegisteredAt *time.Time

	// 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.
	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.
	Exclusions map[string]*types.Exclusion
	// Exclusion details that cannot be described. An error code is provided for each
	// failed item.
	FailedItems map[string]*types.FailedItemDetails

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

type DescribeFindingsInput

type DescribeFindingsInput struct {
	// The locale into which you want to translate a finding description,
	// recommendation, and the short description that identifies the finding.
	Locale types.Locale
	// The ARN that specifies the finding that you want to describe.
	FindingArns []*string
}

type DescribeFindingsOutput

type DescribeFindingsOutput struct {
	// Information about the finding.
	Findings []*types.Finding
	// Finding details that cannot be described. An error code is provided for each
	// failed item.
	FailedItems map[string]*types.FailedItemDetails

	// 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.
	ResourceGroupArns []*string
}

type DescribeResourceGroupsOutput

type DescribeResourceGroupsOutput struct {
	// Resource group details that cannot be described. An error code is provided for
	// each failed item.
	FailedItems map[string]*types.FailedItemDetails
	// Information about a resource group.
	ResourceGroups []*types.ResourceGroup

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

type DescribeRulesPackagesInput

type DescribeRulesPackagesInput struct {
	// The locale that you want to translate a rules package description into.
	Locale types.Locale
	// The ARN that specifies the rules package that you want to describe.
	RulesPackageArns []*string
}

type DescribeRulesPackagesOutput

type DescribeRulesPackagesOutput struct {
	// Information about the rules package.
	RulesPackages []*types.RulesPackage
	// Rules package details that cannot be described. An error code is provided for
	// each failed item.
	FailedItems map[string]*types.FailedItemDetails

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

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)

type GetAssessmentReportInput

type GetAssessmentReportInput struct {
	// Specifies the file format (html or pdf) of the assessment report that you want
	// to generate.
	ReportFileFormat types.ReportFileFormat
	// The ARN that specifies the assessment run for which you want to generate a
	// report.
	AssessmentRunArn *string
	// 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).
	ReportType types.ReportType
}

type GetAssessmentReportOutput

type GetAssessmentReportOutput struct {
	// Specifies the status of the request to generate an assessment report.
	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 GetExclusionsPreviewInput

type GetExclusionsPreviewInput struct {
	// The ARN that specifies the assessment template for which the exclusions preview
	// was requested.
	AssessmentTemplateArn *string
	// The locale into which you want to translate the exclusion's title, description,
	// and recommendation.
	Locale types.Locale
	// The unique identifier associated of the exclusions preview.
	PreviewToken *string
	// 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
	// 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
}

type GetExclusionsPreviewOutput

type GetExclusionsPreviewOutput struct {
	// 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
	// Specifies the status of the request to generate an exclusions preview.
	PreviewStatus types.PreviewStatus

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

type GetTelemetryMetadataInput

type GetTelemetryMetadataInput struct {
	// The ARN that specifies the assessment run that has the telemetry data that you
	// want to obtain.
	AssessmentRunArn *string
}

type GetTelemetryMetadataOutput

type GetTelemetryMetadataOutput struct {
	// Telemetry details.
	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) error
}

type ListAssessmentRunAgentsInput

type ListAssessmentRunAgentsInput struct {
	// 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
	// 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
	// The ARN that specifies the assessment run whose agents you want to list.
	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
}

type ListAssessmentRunAgentsOutput

type ListAssessmentRunAgentsOutput struct {
	// A list of ARNs that specifies the agents returned by the action.
	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 ListAssessmentRunsInput

type ListAssessmentRunsInput 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.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
	// The ARNs that specify the assessment templates whose assessment runs you want to
	// list.
	AssessmentTemplateArns []*string
}

type ListAssessmentRunsOutput

type ListAssessmentRunsOutput struct {
	// 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
	// A list of ARNs that specifies the assessment runs that are returned by the
	// action.
	AssessmentRunArns []*string

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

type ListAssessmentTargetsInput

type ListAssessmentTargetsInput struct {
	// 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
	// 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 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
}

type ListAssessmentTargetsOutput

type ListAssessmentTargetsOutput struct {
	// A list of ARNs that specifies the assessment targets that are returned by the
	// action.
	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 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.
	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 ListEventSubscriptionsInput

type ListEventSubscriptionsInput struct {
	// 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
	// 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
	// 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.
	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 ListExclusionsInput

type ListExclusionsInput 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.
	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
	// The ARN of the assessment run that generated the exclusions that you want to
	// list.
	AssessmentRunArn *string
}

type ListExclusionsOutput

type ListExclusionsOutput struct {
	// A list of exclusions' ARNs returned by the action.
	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 ListFindingsInput

type ListFindingsInput struct {
	// 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
	// The ARNs of the assessment runs that generate the findings that you want to
	// list.
	AssessmentRunArns []*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 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
}

type ListFindingsOutput

type ListFindingsOutput struct {
	// 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
	// A list of ARNs that specifies the findings returned by the action.
	FindingArns []*string

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

type ListRulesPackagesInput

type ListRulesPackagesInput struct {
	// 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
	// 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
}

type ListRulesPackagesOutput

type ListRulesPackagesOutput struct {
	// 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
	// The list of ARNs that specifies the rules packages returned by the action.
	RulesPackageArns []*string

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

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// The ARN that specifies the assessment template whose tags you want to list.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// A collection of key and value pairs.
	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

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

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// 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 retry.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.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PreviewAgentsInput

type PreviewAgentsInput struct {
	// The ARN of the assessment target whose agents you want to preview.
	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 {
	// 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
	// The resulting list of agents.
	AgentPreviews []*types.AgentPreview

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

type RegisterCrossAccountAccessRoleInput

type RegisterCrossAccountAccessRoleInput struct {
	// The ARN of the IAM role that grants Amazon Inspector access to AWS Services
	// needed to perform security assessments.
	RoleArn *string
}

type RegisterCrossAccountAccessRoleOutput

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

type RemoveAttributesFromFindingsInput

type RemoveAttributesFromFindingsInput struct {
	// The ARNs that specify the findings that you want to remove attributes from.
	FindingArns []*string
	// The array of attribute keys that you want to remove from specified findings.
	AttributeKeys []*string
}

type RemoveAttributesFromFindingsOutput

type RemoveAttributesFromFindingsOutput struct {
	// Attributes details that cannot be described. An error code is provided for each
	// failed item.
	FailedItems map[string]*types.FailedItemDetails

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type SetTagsForResourceInput

type SetTagsForResourceInput struct {
	// A collection of key and value pairs that you want to set to the assessment
	// template.
	Tags []*types.Tag
	// The ARN of the assessment template that you want to set tags to.
	ResourceArn *string
}

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.
	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.
	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.
	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 ARN of the SNS topic to which the SNS notifications are sent.
	TopicArn *string
	// The event for which you want to receive SNS notifications.
	Event types.InspectorEvent
	// The ARN of the assessment template that is used during the event for which you
	// want to receive SNS notifications.
	ResourceArn *string
}

type SubscribeToEventOutput

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

type UnsubscribeFromEventInput

type UnsubscribeFromEventInput struct {
	// The ARN of the assessment template that is used during the event for which you
	// want to stop receiving SNS notifications.
	ResourceArn *string
	// The event for which you want to stop receiving SNS notifications.
	Event types.InspectorEvent
	// The ARN of the SNS topic to which SNS notifications are sent.
	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.
	AssessmentTargetArn *string
	// The ARN of the resource group that is used to specify the new resource group to
	// associate with the assessment target.
	ResourceGroupArn *string
	// The name of the assessment target that you want to update.
	AssessmentTargetName *string
}

type UpdateAssessmentTargetOutput

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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