accessanalyzer

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 42

Documentation

Overview

Package accessanalyzer provides the client and types for making API requests to Access Analyzer.

AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. This guide describes the AWS IAM Access Analyzer operations that you can call programmatically. For general information about Access Analyzer, see the AWS IAM Access Analyzer section of the IAM User Guide (https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html).

To start using Access Analyzer, you first need to create an analyzer.

See https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01 for more information on this service.

See accessanalyzer package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/accessanalyzer/

Using the Client

To use Access Analyzer with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Access Analyzer client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/accessanalyzer/#New

Index

Constants

View Source 
const (
	ServiceName = "Access Analyzer" // Service's name
	ServiceID   = "AccessAnalyzer"  // Service's identifier
	EndpointsID = "access-analyzer" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A conflict exception error.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Internal server error.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// Service quote met error.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Throttling limit exceeded error.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Validation exception error.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AnalyzedResource 

type AnalyzedResource struct {

	// The actions that an external principal is granted permission to use by the
	// policy that generated the finding.
	Actions []string `locationName:"actions" type:"list"`

	// The time at which the resource was analyzed.
	//
	// AnalyzedAt is a required field
	AnalyzedAt *time.Time `locationName:"analyzedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The time at which the finding was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// An error message.
	Error *string `locationName:"error" type:"string"`

	// Indicates whether the policy that generated the finding grants public access
	// to the resource.
	//
	// IsPublic is a required field
	IsPublic *bool `locationName:"isPublic" type:"boolean" required:"true"`

	// The ARN of the resource that was analyzed.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The AWS account ID that owns the resource.
	//
	// ResourceOwnerAccount is a required field
	ResourceOwnerAccount *string `locationName:"resourceOwnerAccount" type:"string" required:"true"`

	// The type of the resource that was analyzed.
	//
	// ResourceType is a required field
	ResourceType ResourceType `locationName:"resourceType" type:"string" required:"true" enum:"true"`

	// Indicates how the access that generated the finding is granted. This is populated
	// for Amazon S3 bucket findings.
	SharedVia []string `locationName:"sharedVia" type:"list"`

	// The current status of the finding generated from the analyzed resource.
	Status FindingStatus `locationName:"status" type:"string" enum:"true"`

	// The time at which the finding was updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the analyzed resource.

func (AnalyzedResource) MarshalFields 

func (s AnalyzedResource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyzedResource) String 

func (s AnalyzedResource) String() string

String returns the string representation

type AnalyzedResourceSummary 

type AnalyzedResourceSummary struct {

	// The ARN of the analyzed resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The AWS account ID that owns the resource.
	//
	// ResourceOwnerAccount is a required field
	ResourceOwnerAccount *string `locationName:"resourceOwnerAccount" type:"string" required:"true"`

	// The type of resource that was analyzed.
	//
	// ResourceType is a required field
	ResourceType ResourceType `locationName:"resourceType" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Contains the ARN of the analyzed resource.

func (AnalyzedResourceSummary) MarshalFields 

func (s AnalyzedResourceSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyzedResourceSummary) String 

func (s AnalyzedResourceSummary) String() string

String returns the string representation

type AnalyzerStatus added in v0.21.0 

type AnalyzerStatus string
const (
	AnalyzerStatusActive   AnalyzerStatus = "ACTIVE"
	AnalyzerStatusCreating AnalyzerStatus = "CREATING"
	AnalyzerStatusDisabled AnalyzerStatus = "DISABLED"
	AnalyzerStatusFailed   AnalyzerStatus = "FAILED"
)

Enum values for AnalyzerStatus

func (AnalyzerStatus) MarshalValue added in v0.21.0 

func (enum AnalyzerStatus) MarshalValue() (string, error)

func (AnalyzerStatus) MarshalValueBuf added in v0.21.0 

func (enum AnalyzerStatus) MarshalValueBuf(b []byte) ([]byte, error)

type AnalyzerSummary 

type AnalyzerSummary struct {

	// The ARN of the analyzer.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// A timestamp for the time at which the analyzer was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The resource that was most recently analyzed by the analyzer.
	LastResourceAnalyzed *string `locationName:"lastResourceAnalyzed" type:"string"`

	// The time at which the most recently analyzed resource was analyzed.
	LastResourceAnalyzedAt *time.Time `locationName:"lastResourceAnalyzedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The name of the analyzer.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The status of the analyzer. An Active analyzer successfully monitors supported
	// resources and generates new findings. The analyzer is Disabled when a user
	// action, such as removing trusted access for IAM Access Analyzer from AWS
	// Organizations, causes the analyzer to stop generating new findings. The status
	// is Creating when the analyzer creation is in progress and Failed when the
	// analyzer creation has failed.
	//
	// Status is a required field
	Status AnalyzerStatus `locationName:"status" type:"string" required:"true" enum:"true"`

	// The statusReason provides more details about the current status of the analyzer.
	// For example, if the creation for the analyzer fails, a Failed status is displayed.
	// For an analyzer with organization as the type, this failure can be due to
	// an issue with creating the service-linked roles required in the member accounts
	// of the AWS organization.
	StatusReason *StatusReason `locationName:"statusReason" type:"structure"`

	// The tags added to the analyzer.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The type of analyzer, which corresponds to the zone of trust chosen for the
	// analyzer.
	//
	// Type is a required field
	Type Type `locationName:"type" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about the analyzer.

func (AnalyzerSummary) MarshalFields 

func (s AnalyzerSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnalyzerSummary) String 

func (s AnalyzerSummary) String() string

String returns the string representation

type ArchiveRuleSummary 

type ArchiveRuleSummary struct {

	// The time at which the archive rule was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// A filter used to define the archive rule.
	//
	// Filter is a required field
	Filter map[string]Criterion `locationName:"filter" type:"map" required:"true"`

	// The name of the archive rule.
	//
	// RuleName is a required field
	RuleName *string `locationName:"ruleName" min:"1" type:"string" required:"true"`

	// The time at which the archive rule was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains information about an archive rule.

func (ArchiveRuleSummary) MarshalFields 

func (s ArchiveRuleSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ArchiveRuleSummary) String 

func (s ArchiveRuleSummary) String() string

String returns the string representation

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Access Analyzer. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := accessanalyzer.New(myConfig)

func (*Client) CreateAnalyzerRequest 

func (c *Client) CreateAnalyzerRequest(input *CreateAnalyzerInput) CreateAnalyzerRequest

CreateAnalyzerRequest returns a request value for making API operation for Access Analyzer.

Creates an analyzer for your account. 

// Example sending a request using CreateAnalyzerRequest.
req := client.CreateAnalyzerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/CreateAnalyzer

func (*Client) CreateArchiveRuleRequest 

func (c *Client) CreateArchiveRuleRequest(input *CreateArchiveRuleInput) CreateArchiveRuleRequest

CreateArchiveRuleRequest returns a request value for making API operation for Access Analyzer.

Creates an archive rule for the specified analyzer. Archive rules automatically archive findings that meet the criteria you define when you create the rule. 

// Example sending a request using CreateArchiveRuleRequest.
req := client.CreateArchiveRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/CreateArchiveRule

func (*Client) DeleteAnalyzerRequest 

func (c *Client) DeleteAnalyzerRequest(input *DeleteAnalyzerInput) DeleteAnalyzerRequest

DeleteAnalyzerRequest returns a request value for making API operation for Access Analyzer.

Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the account in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action. 

// Example sending a request using DeleteAnalyzerRequest.
req := client.DeleteAnalyzerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/DeleteAnalyzer

func (*Client) DeleteArchiveRuleRequest 

func (c *Client) DeleteArchiveRuleRequest(input *DeleteArchiveRuleInput) DeleteArchiveRuleRequest

DeleteArchiveRuleRequest returns a request value for making API operation for Access Analyzer.

Deletes the specified archive rule. 

// Example sending a request using DeleteArchiveRuleRequest.
req := client.DeleteArchiveRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/DeleteArchiveRule

func (*Client) GetAnalyzedResourceRequest 

func (c *Client) GetAnalyzedResourceRequest(input *GetAnalyzedResourceInput) GetAnalyzedResourceRequest

GetAnalyzedResourceRequest returns a request value for making API operation for Access Analyzer.

Retrieves information about a resource that was analyzed. 

// Example sending a request using GetAnalyzedResourceRequest.
req := client.GetAnalyzedResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetAnalyzedResource

func (*Client) GetAnalyzerRequest 

func (c *Client) GetAnalyzerRequest(input *GetAnalyzerInput) GetAnalyzerRequest

GetAnalyzerRequest returns a request value for making API operation for Access Analyzer.

Retrieves information about the specified analyzer. 

// Example sending a request using GetAnalyzerRequest.
req := client.GetAnalyzerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetAnalyzer

func (*Client) GetArchiveRuleRequest 

func (c *Client) GetArchiveRuleRequest(input *GetArchiveRuleInput) GetArchiveRuleRequest

GetArchiveRuleRequest returns a request value for making API operation for Access Analyzer.

Retrieves information about an archive rule. 

// Example sending a request using GetArchiveRuleRequest.
req := client.GetArchiveRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetArchiveRule

func (*Client) GetFindingRequest 

func (c *Client) GetFindingRequest(input *GetFindingInput) GetFindingRequest

GetFindingRequest returns a request value for making API operation for Access Analyzer.

Retrieves information about the specified finding. 

// Example sending a request using GetFindingRequest.
req := client.GetFindingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetFinding

func (*Client) ListAnalyzedResourcesRequest 

func (c *Client) ListAnalyzedResourcesRequest(input *ListAnalyzedResourcesInput) ListAnalyzedResourcesRequest

ListAnalyzedResourcesRequest returns a request value for making API operation for Access Analyzer.

Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer.. 

// Example sending a request using ListAnalyzedResourcesRequest.
req := client.ListAnalyzedResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListAnalyzedResources

func (*Client) ListAnalyzersRequest 

func (c *Client) ListAnalyzersRequest(input *ListAnalyzersInput) ListAnalyzersRequest

ListAnalyzersRequest returns a request value for making API operation for Access Analyzer.

Retrieves a list of analyzers. 

// Example sending a request using ListAnalyzersRequest.
req := client.ListAnalyzersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListAnalyzers

func (*Client) ListArchiveRulesRequest 

func (c *Client) ListArchiveRulesRequest(input *ListArchiveRulesInput) ListArchiveRulesRequest

ListArchiveRulesRequest returns a request value for making API operation for Access Analyzer.

Retrieves a list of archive rules created for the specified analyzer. 

// Example sending a request using ListArchiveRulesRequest.
req := client.ListArchiveRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListArchiveRules

func (*Client) ListFindingsRequest 

func (c *Client) ListFindingsRequest(input *ListFindingsInput) ListFindingsRequest

ListFindingsRequest returns a request value for making API operation for Access Analyzer.

Retrieves a list of findings generated by the specified analyzer. 

// Example sending a request using ListFindingsRequest.
req := client.ListFindingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListFindings

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Access Analyzer.

Retrieves a list of tags applied to the specified resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListTagsForResource

func (*Client) StartResourceScanRequest 

func (c *Client) StartResourceScanRequest(input *StartResourceScanInput) StartResourceScanRequest

StartResourceScanRequest returns a request value for making API operation for Access Analyzer.

Immediately starts a scan of the policies applied to the specified resource. 

// Example sending a request using StartResourceScanRequest.
req := client.StartResourceScanRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/StartResourceScan

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Access Analyzer.

Adds a tag to the specified resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/TagResource

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Access Analyzer.

Removes a tag from the specified resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UntagResource

func (*Client) UpdateArchiveRuleRequest 

func (c *Client) UpdateArchiveRuleRequest(input *UpdateArchiveRuleInput) UpdateArchiveRuleRequest

UpdateArchiveRuleRequest returns a request value for making API operation for Access Analyzer.

Updates the criteria and values for the specified archive rule. 

// Example sending a request using UpdateArchiveRuleRequest.
req := client.UpdateArchiveRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UpdateArchiveRule

func (*Client) UpdateFindingsRequest 

func (c *Client) UpdateFindingsRequest(input *UpdateFindingsInput) UpdateFindingsRequest

UpdateFindingsRequest returns a request value for making API operation for Access Analyzer.

Updates the status for the specified findings. 

// Example sending a request using UpdateFindingsRequest.
req := client.UpdateFindingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UpdateFindings

type CreateAnalyzerInput 

type CreateAnalyzerInput struct {

	// The name of the analyzer to create.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// Specifies the archive rules to add for the analyzer. Archive rules automatically
	// archive findings that meet the criteria you define for the rule.
	ArchiveRules []InlineArchiveRule `locationName:"archiveRules" type:"list"`

	// A client token.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The tags to apply to the analyzer.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The type of analyzer to create. Only ACCOUNT analyzers are supported. You
	// can create only one analyzer per account per Region.
	//
	// Type is a required field
	Type Type `locationName:"type" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Creates an analyzer.

func (CreateAnalyzerInput) MarshalFields 

func (s CreateAnalyzerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAnalyzerInput) String 

func (s CreateAnalyzerInput) String() string

String returns the string representation

func (*CreateAnalyzerInput) Validate 

func (s *CreateAnalyzerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAnalyzerOutput 

type CreateAnalyzerOutput struct {

	// The ARN of the analyzer that was created by the request.
	Arn *string `locationName:"arn" type:"string"`
	// contains filtered or unexported fields
}

The response to the request to create an analyzer.

func (CreateAnalyzerOutput) MarshalFields 

func (s CreateAnalyzerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAnalyzerOutput) String 

func (s CreateAnalyzerOutput) String() string

String returns the string representation

type CreateAnalyzerRequest 

type CreateAnalyzerRequest struct {
	*aws.Request
	Input *CreateAnalyzerInput
	Copy  func(*CreateAnalyzerInput) CreateAnalyzerRequest
}

CreateAnalyzerRequest is the request type for the CreateAnalyzer API operation.

func (CreateAnalyzerRequest) Send 

func (r CreateAnalyzerRequest) Send(ctx context.Context) (*CreateAnalyzerResponse, error)

Send marshals and sends the CreateAnalyzer API request.

type CreateAnalyzerResponse 

type CreateAnalyzerResponse struct {
	*CreateAnalyzerOutput
	// contains filtered or unexported fields
}

CreateAnalyzerResponse is the response type for the CreateAnalyzer API operation.

func (*CreateAnalyzerResponse) SDKResponseMetdata 

func (r *CreateAnalyzerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAnalyzer request.

type CreateArchiveRuleInput 

type CreateArchiveRuleInput struct {

	// The name of the created analyzer.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// A client token.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The criteria for the rule.
	//
	// Filter is a required field
	Filter map[string]Criterion `locationName:"filter" type:"map" required:"true"`

	// The name of the rule to create.
	//
	// RuleName is a required field
	RuleName *string `locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Creates an archive rule.

func (CreateArchiveRuleInput) MarshalFields 

func (s CreateArchiveRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateArchiveRuleInput) String 

func (s CreateArchiveRuleInput) String() string

String returns the string representation

func (*CreateArchiveRuleInput) Validate 

func (s *CreateArchiveRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateArchiveRuleOutput 

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

func (CreateArchiveRuleOutput) MarshalFields 

func (s CreateArchiveRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateArchiveRuleOutput) String 

func (s CreateArchiveRuleOutput) String() string

String returns the string representation

type CreateArchiveRuleRequest 

type CreateArchiveRuleRequest struct {
	*aws.Request
	Input *CreateArchiveRuleInput
	Copy  func(*CreateArchiveRuleInput) CreateArchiveRuleRequest
}

CreateArchiveRuleRequest is the request type for the CreateArchiveRule API operation.

func (CreateArchiveRuleRequest) Send 

func (r CreateArchiveRuleRequest) Send(ctx context.Context) (*CreateArchiveRuleResponse, error)

Send marshals and sends the CreateArchiveRule API request.

type CreateArchiveRuleResponse 

type CreateArchiveRuleResponse struct {
	*CreateArchiveRuleOutput
	// contains filtered or unexported fields
}

CreateArchiveRuleResponse is the response type for the CreateArchiveRule API operation.

func (*CreateArchiveRuleResponse) SDKResponseMetdata 

func (r *CreateArchiveRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateArchiveRule request.

type Criterion 

type Criterion struct {

	// A "contains" operator to match for the filter used to create the rule.
	Contains []string `locationName:"contains" min:"1" type:"list"`

	// An "equals" operator to match for the filter used to create the rule.
	Eq []string `locationName:"eq" min:"1" type:"list"`

	// An "exists" operator to match for the filter used to create the rule.
	Exists *bool `locationName:"exists" type:"boolean"`

	// A "not equals" operator to match for the filter used to create the rule.
	Neq []string `locationName:"neq" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The criteria to use in the filter that defines the archive rule.

func (Criterion) MarshalFields 

func (s Criterion) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Criterion) String 

func (s Criterion) String() string

String returns the string representation

func (*Criterion) Validate 

func (s *Criterion) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAnalyzerInput 

type DeleteAnalyzerInput struct {

	// The name of the analyzer to delete.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// A client token.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

Deletes an analyzer.

func (DeleteAnalyzerInput) MarshalFields 

func (s DeleteAnalyzerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAnalyzerInput) String 

func (s DeleteAnalyzerInput) String() string

String returns the string representation

func (*DeleteAnalyzerInput) Validate 

func (s *DeleteAnalyzerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAnalyzerOutput 

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

func (DeleteAnalyzerOutput) MarshalFields 

func (s DeleteAnalyzerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAnalyzerOutput) String 

func (s DeleteAnalyzerOutput) String() string

String returns the string representation

type DeleteAnalyzerRequest 

type DeleteAnalyzerRequest struct {
	*aws.Request
	Input *DeleteAnalyzerInput
	Copy  func(*DeleteAnalyzerInput) DeleteAnalyzerRequest
}

DeleteAnalyzerRequest is the request type for the DeleteAnalyzer API operation.

func (DeleteAnalyzerRequest) Send 

func (r DeleteAnalyzerRequest) Send(ctx context.Context) (*DeleteAnalyzerResponse, error)

Send marshals and sends the DeleteAnalyzer API request.

type DeleteAnalyzerResponse 

type DeleteAnalyzerResponse struct {
	*DeleteAnalyzerOutput
	// contains filtered or unexported fields
}

DeleteAnalyzerResponse is the response type for the DeleteAnalyzer API operation.

func (*DeleteAnalyzerResponse) SDKResponseMetdata 

func (r *DeleteAnalyzerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAnalyzer request.

type DeleteArchiveRuleInput 

type DeleteArchiveRuleInput struct {

	// The name of the analyzer that associated with the archive rule to delete.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// A client token.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of the rule to delete.
	//
	// RuleName is a required field
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deletes an archive rule.

func (DeleteArchiveRuleInput) MarshalFields 

func (s DeleteArchiveRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteArchiveRuleInput) String 

func (s DeleteArchiveRuleInput) String() string

String returns the string representation

func (*DeleteArchiveRuleInput) Validate 

func (s *DeleteArchiveRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteArchiveRuleOutput 

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

func (DeleteArchiveRuleOutput) MarshalFields 

func (s DeleteArchiveRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteArchiveRuleOutput) String 

func (s DeleteArchiveRuleOutput) String() string

String returns the string representation

type DeleteArchiveRuleRequest 

type DeleteArchiveRuleRequest struct {
	*aws.Request
	Input *DeleteArchiveRuleInput
	Copy  func(*DeleteArchiveRuleInput) DeleteArchiveRuleRequest
}

DeleteArchiveRuleRequest is the request type for the DeleteArchiveRule API operation.

func (DeleteArchiveRuleRequest) Send 

func (r DeleteArchiveRuleRequest) Send(ctx context.Context) (*DeleteArchiveRuleResponse, error)

Send marshals and sends the DeleteArchiveRule API request.

type DeleteArchiveRuleResponse 

type DeleteArchiveRuleResponse struct {
	*DeleteArchiveRuleOutput
	// contains filtered or unexported fields
}

DeleteArchiveRuleResponse is the response type for the DeleteArchiveRule API operation.

func (*DeleteArchiveRuleResponse) SDKResponseMetdata 

func (r *DeleteArchiveRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteArchiveRule request.

type Finding 

type Finding struct {

	// The action in the analyzed policy statement that an external principal has
	// permission to use.
	Action []string `locationName:"action" type:"list"`

	// The time at which the resource was analyzed.
	//
	// AnalyzedAt is a required field
	AnalyzedAt *time.Time `locationName:"analyzedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The condition in the analyzed policy statement that resulted in a finding.
	//
	// Condition is a required field
	Condition map[string]string `locationName:"condition" type:"map" required:"true"`

	// The time at which the finding was generated.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// An error.
	Error *string `locationName:"error" type:"string"`

	// The ID of the finding.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// Indicates whether the policy that generated the finding allows public access
	// to the resource.
	IsPublic *bool `locationName:"isPublic" type:"boolean"`

	// The external principal that access to a resource within the zone of trust.
	Principal map[string]string `locationName:"principal" type:"map"`

	// The resource that an external principal has access to.
	Resource *string `locationName:"resource" type:"string"`

	// The AWS account ID that owns the resource.
	//
	// ResourceOwnerAccount is a required field
	ResourceOwnerAccount *string `locationName:"resourceOwnerAccount" type:"string" required:"true"`

	// The type of the resource reported in the finding.
	//
	// ResourceType is a required field
	ResourceType ResourceType `locationName:"resourceType" type:"string" required:"true" enum:"true"`

	// The sources of the finding. This indicates how the access that generated
	// the finding is granted. It is populated for Amazon S3 bucket findings.
	Sources []FindingSource `locationName:"sources" type:"list"`

	// The current status of the finding.
	//
	// Status is a required field
	Status FindingStatus `locationName:"status" type:"string" required:"true" enum:"true"`

	// The time at which the finding was updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a finding.

func (Finding) MarshalFields 

func (s Finding) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Finding) String 

func (s Finding) String() string

String returns the string representation

type FindingSource added in v0.22.0 

type FindingSource struct {

	// Includes details about how the access that generated the finding is granted.
	// This is populated for Amazon S3 bucket findings.
	Detail *FindingSourceDetail `locationName:"detail" type:"structure"`

	// Indicates the type of access that generated the finding.
	//
	// Type is a required field
	Type FindingSourceType `locationName:"type" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

func (FindingSource) MarshalFields added in v0.22.0 

func (s FindingSource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FindingSource) String added in v0.22.0 

func (s FindingSource) String() string

String returns the string representation

type FindingSourceDetail added in v0.22.0 

type FindingSourceDetail struct {

	// The ARN of the access point that generated the finding.
	AccessPointArn *string `locationName:"accessPointArn" type:"string"`
	// contains filtered or unexported fields
}

Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

func (FindingSourceDetail) MarshalFields added in v0.22.0 

func (s FindingSourceDetail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FindingSourceDetail) String added in v0.22.0 

func (s FindingSourceDetail) String() string

String returns the string representation

type FindingSourceType added in v0.22.0 

type FindingSourceType string
const (
	FindingSourceTypeBucketAcl     FindingSourceType = "BUCKET_ACL"
	FindingSourceTypePolicy        FindingSourceType = "POLICY"
	FindingSourceTypeS3AccessPoint FindingSourceType = "S3_ACCESS_POINT"
)

Enum values for FindingSourceType

func (FindingSourceType) MarshalValue added in v0.22.0 

func (enum FindingSourceType) MarshalValue() (string, error)

func (FindingSourceType) MarshalValueBuf added in v0.22.0 

func (enum FindingSourceType) MarshalValueBuf(b []byte) ([]byte, error)

type FindingStatus 

type FindingStatus string
const (
	FindingStatusActive   FindingStatus = "ACTIVE"
	FindingStatusArchived FindingStatus = "ARCHIVED"
	FindingStatusResolved FindingStatus = "RESOLVED"
)

Enum values for FindingStatus

func (FindingStatus) MarshalValue 

func (enum FindingStatus) MarshalValue() (string, error)

func (FindingStatus) MarshalValueBuf 

func (enum FindingStatus) MarshalValueBuf(b []byte) ([]byte, error)

type FindingStatusUpdate 

type FindingStatusUpdate string
const (
	FindingStatusUpdateActive   FindingStatusUpdate = "ACTIVE"
	FindingStatusUpdateArchived FindingStatusUpdate = "ARCHIVED"
)

Enum values for FindingStatusUpdate

func (FindingStatusUpdate) MarshalValue 

func (enum FindingStatusUpdate) MarshalValue() (string, error)

func (FindingStatusUpdate) MarshalValueBuf 

func (enum FindingStatusUpdate) MarshalValueBuf(b []byte) ([]byte, error)

type FindingSummary 

type FindingSummary struct {

	// The action in the analyzed policy statement that an external principal has
	// permission to use.
	Action []string `locationName:"action" type:"list"`

	// The time at which the resource-based policy that generated the finding was
	// analyzed.
	//
	// AnalyzedAt is a required field
	AnalyzedAt *time.Time `locationName:"analyzedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The condition in the analyzed policy statement that resulted in a finding.
	//
	// Condition is a required field
	Condition map[string]string `locationName:"condition" type:"map" required:"true"`

	// The time at which the finding was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The error that resulted in an Error finding.
	Error *string `locationName:"error" type:"string"`

	// The ID of the finding.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// Indicates whether the finding reports a resource that has a policy that allows
	// public access.
	IsPublic *bool `locationName:"isPublic" type:"boolean"`

	// The external principal that has access to a resource within the zone of trust.
	Principal map[string]string `locationName:"principal" type:"map"`

	// The resource that the external principal has access to.
	Resource *string `locationName:"resource" type:"string"`

	// The AWS account ID that owns the resource.
	//
	// ResourceOwnerAccount is a required field
	ResourceOwnerAccount *string `locationName:"resourceOwnerAccount" type:"string" required:"true"`

	// The type of the resource that the external principal has access to.
	//
	// ResourceType is a required field
	ResourceType ResourceType `locationName:"resourceType" type:"string" required:"true" enum:"true"`

	// The sources of the finding. This indicates how the access that generated
	// the finding is granted. It is populated for Amazon S3 bucket findings.
	Sources []FindingSource `locationName:"sources" type:"list"`

	// The status of the finding.
	//
	// Status is a required field
	Status FindingStatus `locationName:"status" type:"string" required:"true" enum:"true"`

	// The time at which the finding was most recently updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a finding.

func (FindingSummary) MarshalFields 

func (s FindingSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FindingSummary) String 

func (s FindingSummary) String() string

String returns the string representation

type GetAnalyzedResourceInput 

type GetAnalyzedResourceInput struct {

	// The ARN of the analyzer to retrieve information from.
	//
	// AnalyzerArn is a required field
	AnalyzerArn *string `location:"querystring" locationName:"analyzerArn" type:"string" required:"true"`

	// The ARN of the resource to retrieve information about.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Retrieves an analyzed resource.

func (GetAnalyzedResourceInput) MarshalFields 

func (s GetAnalyzedResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAnalyzedResourceInput) String 

func (s GetAnalyzedResourceInput) String() string

String returns the string representation

func (*GetAnalyzedResourceInput) Validate 

func (s *GetAnalyzedResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAnalyzedResourceOutput 

type GetAnalyzedResourceOutput struct {

	// An AnalyedResource object that contains information that Access Analyzer
	// found when it analyzed the resource.
	Resource *AnalyzedResource `locationName:"resource" type:"structure"`
	// contains filtered or unexported fields
}

The response to the request.

func (GetAnalyzedResourceOutput) MarshalFields 

func (s GetAnalyzedResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAnalyzedResourceOutput) String 

func (s GetAnalyzedResourceOutput) String() string

String returns the string representation

type GetAnalyzedResourceRequest 

type GetAnalyzedResourceRequest struct {
	*aws.Request
	Input *GetAnalyzedResourceInput
	Copy  func(*GetAnalyzedResourceInput) GetAnalyzedResourceRequest
}

GetAnalyzedResourceRequest is the request type for the GetAnalyzedResource API operation.

func (GetAnalyzedResourceRequest) Send 

func (r GetAnalyzedResourceRequest) Send(ctx context.Context) (*GetAnalyzedResourceResponse, error)

Send marshals and sends the GetAnalyzedResource API request.

type GetAnalyzedResourceResponse 

type GetAnalyzedResourceResponse struct {
	*GetAnalyzedResourceOutput
	// contains filtered or unexported fields
}

GetAnalyzedResourceResponse is the response type for the GetAnalyzedResource API operation.

func (*GetAnalyzedResourceResponse) SDKResponseMetdata 

func (r *GetAnalyzedResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAnalyzedResource request.

type GetAnalyzerInput 

type GetAnalyzerInput struct {

	// The name of the analyzer retrieved.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Retrieves an analyzer.

func (GetAnalyzerInput) MarshalFields 

func (s GetAnalyzerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAnalyzerInput) String 

func (s GetAnalyzerInput) String() string

String returns the string representation

func (*GetAnalyzerInput) Validate 

func (s *GetAnalyzerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAnalyzerOutput 

type GetAnalyzerOutput struct {

	// An AnalyzerSummary object that contains information about the analyzer.
	//
	// Analyzer is a required field
	Analyzer *AnalyzerSummary `locationName:"analyzer" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The response to the request.

func (GetAnalyzerOutput) MarshalFields 

func (s GetAnalyzerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAnalyzerOutput) String 

func (s GetAnalyzerOutput) String() string

String returns the string representation

type GetAnalyzerRequest 

type GetAnalyzerRequest struct {
	*aws.Request
	Input *GetAnalyzerInput
	Copy  func(*GetAnalyzerInput) GetAnalyzerRequest
}

GetAnalyzerRequest is the request type for the GetAnalyzer API operation.

func (GetAnalyzerRequest) Send 

func (r GetAnalyzerRequest) Send(ctx context.Context) (*GetAnalyzerResponse, error)

Send marshals and sends the GetAnalyzer API request.

type GetAnalyzerResponse 

type GetAnalyzerResponse struct {
	*GetAnalyzerOutput
	// contains filtered or unexported fields
}

GetAnalyzerResponse is the response type for the GetAnalyzer API operation.

func (*GetAnalyzerResponse) SDKResponseMetdata 

func (r *GetAnalyzerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAnalyzer request.

type GetArchiveRuleInput 

type GetArchiveRuleInput struct {

	// The name of the analyzer to retrieve rules from.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// The name of the rule to retrieve.
	//
	// RuleName is a required field
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Retrieves an archive rule.

func (GetArchiveRuleInput) MarshalFields 

func (s GetArchiveRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetArchiveRuleInput) String 

func (s GetArchiveRuleInput) String() string

String returns the string representation

func (*GetArchiveRuleInput) Validate 

func (s *GetArchiveRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetArchiveRuleOutput 

type GetArchiveRuleOutput struct {

	// Contains information about an archive rule.
	//
	// ArchiveRule is a required field
	ArchiveRule *ArchiveRuleSummary `locationName:"archiveRule" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The response to the request.

func (GetArchiveRuleOutput) MarshalFields 

func (s GetArchiveRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetArchiveRuleOutput) String 

func (s GetArchiveRuleOutput) String() string

String returns the string representation

type GetArchiveRuleRequest 

type GetArchiveRuleRequest struct {
	*aws.Request
	Input *GetArchiveRuleInput
	Copy  func(*GetArchiveRuleInput) GetArchiveRuleRequest
}

GetArchiveRuleRequest is the request type for the GetArchiveRule API operation.

func (GetArchiveRuleRequest) Send 

func (r GetArchiveRuleRequest) Send(ctx context.Context) (*GetArchiveRuleResponse, error)

Send marshals and sends the GetArchiveRule API request.

type GetArchiveRuleResponse 

type GetArchiveRuleResponse struct {
	*GetArchiveRuleOutput
	// contains filtered or unexported fields
}

GetArchiveRuleResponse is the response type for the GetArchiveRule API operation.

func (*GetArchiveRuleResponse) SDKResponseMetdata 

func (r *GetArchiveRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetArchiveRule request.

type GetFindingInput 

type GetFindingInput struct {

	// The ARN of the analyzer that generated the finding.
	//
	// AnalyzerArn is a required field
	AnalyzerArn *string `location:"querystring" locationName:"analyzerArn" type:"string" required:"true"`

	// The ID of the finding to retrieve.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Retrieves a finding.

func (GetFindingInput) MarshalFields 

func (s GetFindingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFindingInput) String 

func (s GetFindingInput) String() string

String returns the string representation

func (*GetFindingInput) Validate 

func (s *GetFindingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFindingOutput 

type GetFindingOutput struct {

	// A finding object that contains finding details.
	Finding *Finding `locationName:"finding" type:"structure"`
	// contains filtered or unexported fields
}

The response to the request.

func (GetFindingOutput) MarshalFields 

func (s GetFindingOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetFindingOutput) String 

func (s GetFindingOutput) String() string

String returns the string representation

type GetFindingRequest 

type GetFindingRequest struct {
	*aws.Request
	Input *GetFindingInput
	Copy  func(*GetFindingInput) GetFindingRequest
}

GetFindingRequest is the request type for the GetFinding API operation.

func (GetFindingRequest) Send 

func (r GetFindingRequest) Send(ctx context.Context) (*GetFindingResponse, error)

Send marshals and sends the GetFinding API request.

type GetFindingResponse 

type GetFindingResponse struct {
	*GetFindingOutput
	// contains filtered or unexported fields
}

GetFindingResponse is the response type for the GetFinding API operation.

func (*GetFindingResponse) SDKResponseMetdata 

func (r *GetFindingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFinding request.

type InlineArchiveRule 

type InlineArchiveRule struct {

	// The condition and values for a criterion.
	//
	// Filter is a required field
	Filter map[string]Criterion `locationName:"filter" type:"map" required:"true"`

	// The name of the rule.
	//
	// RuleName is a required field
	RuleName *string `locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An criterion statement in an archive rule. Each archive rule may have multiple criteria.

func (InlineArchiveRule) MarshalFields 

func (s InlineArchiveRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InlineArchiveRule) String 

func (s InlineArchiveRule) String() string

String returns the string representation

func (*InlineArchiveRule) Validate 

func (s *InlineArchiveRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAnalyzedResourcesInput 

type ListAnalyzedResourcesInput struct {

	// The ARN of the analyzer to retrieve a list of analyzed resources from.
	//
	// AnalyzerArn is a required field
	AnalyzerArn *string `locationName:"analyzerArn" type:"string" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// A token used for pagination of results returned.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The type of resource.
	ResourceType ResourceType `locationName:"resourceType" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Retrieves a list of resources that have been analyzed.

func (ListAnalyzedResourcesInput) MarshalFields 

func (s ListAnalyzedResourcesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAnalyzedResourcesInput) String 

func (s ListAnalyzedResourcesInput) String() string

String returns the string representation

func (*ListAnalyzedResourcesInput) Validate 

func (s *ListAnalyzedResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAnalyzedResourcesOutput 

type ListAnalyzedResourcesOutput struct {

	// A list of resources that were analyzed.
	//
	// AnalyzedResources is a required field
	AnalyzedResources []AnalyzedResourceSummary `locationName:"analyzedResources" type:"list" required:"true"`

	// A token used for pagination of results returned.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response to the request.

func (ListAnalyzedResourcesOutput) MarshalFields 

func (s ListAnalyzedResourcesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAnalyzedResourcesOutput) String 

func (s ListAnalyzedResourcesOutput) String() string

String returns the string representation

type ListAnalyzedResourcesPaginator 

type ListAnalyzedResourcesPaginator struct {
	aws.Pager
}

ListAnalyzedResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAnalyzedResourcesPaginator 

func NewListAnalyzedResourcesPaginator(req ListAnalyzedResourcesRequest) ListAnalyzedResourcesPaginator

NewListAnalyzedResourcesRequestPaginator returns a paginator for ListAnalyzedResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAnalyzedResourcesRequest(input)
p := accessanalyzer.NewListAnalyzedResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAnalyzedResourcesPaginator) CurrentPage 

func (p *ListAnalyzedResourcesPaginator) CurrentPage() *ListAnalyzedResourcesOutput

type ListAnalyzedResourcesRequest 

type ListAnalyzedResourcesRequest struct {
	*aws.Request
	Input *ListAnalyzedResourcesInput
	Copy  func(*ListAnalyzedResourcesInput) ListAnalyzedResourcesRequest
}

ListAnalyzedResourcesRequest is the request type for the ListAnalyzedResources API operation.

func (ListAnalyzedResourcesRequest) Send 

func (r ListAnalyzedResourcesRequest) Send(ctx context.Context) (*ListAnalyzedResourcesResponse, error)

Send marshals and sends the ListAnalyzedResources API request.

type ListAnalyzedResourcesResponse 

type ListAnalyzedResourcesResponse struct {
	*ListAnalyzedResourcesOutput
	// contains filtered or unexported fields
}

ListAnalyzedResourcesResponse is the response type for the ListAnalyzedResources API operation.

func (*ListAnalyzedResourcesResponse) SDKResponseMetdata 

func (r *ListAnalyzedResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAnalyzedResources request.

type ListAnalyzersInput 

type ListAnalyzersInput struct {

	// The maximum number of results to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// A token used for pagination of results returned.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The type of analyzer.
	Type Type `location:"querystring" locationName:"type" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Retrieves a list of analyzers.

func (ListAnalyzersInput) MarshalFields 

func (s ListAnalyzersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAnalyzersInput) String 

func (s ListAnalyzersInput) String() string

String returns the string representation

type ListAnalyzersOutput 

type ListAnalyzersOutput struct {

	// The analyzers retrieved.
	//
	// Analyzers is a required field
	Analyzers []AnalyzerSummary `locationName:"analyzers" type:"list" required:"true"`

	// A token used for pagination of results returned.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response to the request.

func (ListAnalyzersOutput) MarshalFields 

func (s ListAnalyzersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAnalyzersOutput) String 

func (s ListAnalyzersOutput) String() string

String returns the string representation

type ListAnalyzersPaginator 

type ListAnalyzersPaginator struct {
	aws.Pager
}

ListAnalyzersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAnalyzersPaginator 

func NewListAnalyzersPaginator(req ListAnalyzersRequest) ListAnalyzersPaginator

NewListAnalyzersRequestPaginator returns a paginator for ListAnalyzers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAnalyzersRequest(input)
p := accessanalyzer.NewListAnalyzersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAnalyzersPaginator) CurrentPage 

func (p *ListAnalyzersPaginator) CurrentPage() *ListAnalyzersOutput

type ListAnalyzersRequest 

type ListAnalyzersRequest struct {
	*aws.Request
	Input *ListAnalyzersInput
	Copy  func(*ListAnalyzersInput) ListAnalyzersRequest
}

ListAnalyzersRequest is the request type for the ListAnalyzers API operation.

func (ListAnalyzersRequest) Send 

func (r ListAnalyzersRequest) Send(ctx context.Context) (*ListAnalyzersResponse, error)

Send marshals and sends the ListAnalyzers API request.

type ListAnalyzersResponse 

type ListAnalyzersResponse struct {
	*ListAnalyzersOutput
	// contains filtered or unexported fields
}

ListAnalyzersResponse is the response type for the ListAnalyzers API operation.

func (*ListAnalyzersResponse) SDKResponseMetdata 

func (r *ListAnalyzersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAnalyzers request.

type ListArchiveRulesInput 

type ListArchiveRulesInput struct {

	// The name of the analyzer to retrieve rules from.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// The maximum number of results to return in the request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// A token used for pagination of results returned.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Retrieves a list of archive rules created for the specified analyzer.

func (ListArchiveRulesInput) MarshalFields 

func (s ListArchiveRulesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListArchiveRulesInput) String 

func (s ListArchiveRulesInput) String() string

String returns the string representation

func (*ListArchiveRulesInput) Validate 

func (s *ListArchiveRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListArchiveRulesOutput 

type ListArchiveRulesOutput struct {

	// A list of archive rules created for the specified analyzer.
	//
	// ArchiveRules is a required field
	ArchiveRules []ArchiveRuleSummary `locationName:"archiveRules" type:"list" required:"true"`

	// A token used for pagination of results returned.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response to the request.

func (ListArchiveRulesOutput) MarshalFields 

func (s ListArchiveRulesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListArchiveRulesOutput) String 

func (s ListArchiveRulesOutput) String() string

String returns the string representation

type ListArchiveRulesPaginator 

type ListArchiveRulesPaginator struct {
	aws.Pager
}

ListArchiveRulesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListArchiveRulesPaginator 

func NewListArchiveRulesPaginator(req ListArchiveRulesRequest) ListArchiveRulesPaginator

NewListArchiveRulesRequestPaginator returns a paginator for ListArchiveRules. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListArchiveRulesRequest(input)
p := accessanalyzer.NewListArchiveRulesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListArchiveRulesPaginator) CurrentPage 

func (p *ListArchiveRulesPaginator) CurrentPage() *ListArchiveRulesOutput

type ListArchiveRulesRequest 

type ListArchiveRulesRequest struct {
	*aws.Request
	Input *ListArchiveRulesInput
	Copy  func(*ListArchiveRulesInput) ListArchiveRulesRequest
}

ListArchiveRulesRequest is the request type for the ListArchiveRules API operation.

func (ListArchiveRulesRequest) Send 

func (r ListArchiveRulesRequest) Send(ctx context.Context) (*ListArchiveRulesResponse, error)

Send marshals and sends the ListArchiveRules API request.

type ListArchiveRulesResponse 

type ListArchiveRulesResponse struct {
	*ListArchiveRulesOutput
	// contains filtered or unexported fields
}

ListArchiveRulesResponse is the response type for the ListArchiveRules API operation.

func (*ListArchiveRulesResponse) SDKResponseMetdata 

func (r *ListArchiveRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListArchiveRules request.

type ListFindingsInput 

type ListFindingsInput struct {

	// The ARN of the analyzer to retrieve findings from.
	//
	// AnalyzerArn is a required field
	AnalyzerArn *string `locationName:"analyzerArn" type:"string" required:"true"`

	// A filter to match for the findings to return.
	Filter map[string]Criterion `locationName:"filter" type:"map"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// A token used for pagination of results returned.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The sort order for the findings returned.
	Sort *SortCriteria `locationName:"sort" type:"structure"`
	// contains filtered or unexported fields
}

Retrieves a list of findings generated by the specified analyzer.

func (ListFindingsInput) MarshalFields 

func (s ListFindingsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListFindingsInput) String 

func (s ListFindingsInput) String() string

String returns the string representation

func (*ListFindingsInput) Validate 

func (s *ListFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFindingsOutput 

type ListFindingsOutput struct {

	// A list of findings retrieved from the analyzer that match the filter criteria
	// specified, if any.
	//
	// Findings is a required field
	Findings []FindingSummary `locationName:"findings" type:"list" required:"true"`

	// A token used for pagination of results returned.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response to the request.

func (ListFindingsOutput) MarshalFields 

func (s ListFindingsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListFindingsOutput) String 

func (s ListFindingsOutput) String() string

String returns the string representation

type ListFindingsPaginator 

type ListFindingsPaginator struct {
	aws.Pager
}

ListFindingsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListFindingsPaginator 

func NewListFindingsPaginator(req ListFindingsRequest) ListFindingsPaginator

NewListFindingsRequestPaginator returns a paginator for ListFindings. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListFindingsRequest(input)
p := accessanalyzer.NewListFindingsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListFindingsPaginator) CurrentPage 

func (p *ListFindingsPaginator) CurrentPage() *ListFindingsOutput

type ListFindingsRequest 

type ListFindingsRequest struct {
	*aws.Request
	Input *ListFindingsInput
	Copy  func(*ListFindingsInput) ListFindingsRequest
}

ListFindingsRequest is the request type for the ListFindings API operation.

func (ListFindingsRequest) Send 

func (r ListFindingsRequest) Send(ctx context.Context) (*ListFindingsResponse, error)

Send marshals and sends the ListFindings API request.

type ListFindingsResponse 

type ListFindingsResponse struct {
	*ListFindingsOutput
	// contains filtered or unexported fields
}

ListFindingsResponse is the response type for the ListFindings API operation.

func (*ListFindingsResponse) SDKResponseMetdata 

func (r *ListFindingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListFindings request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource to retrieve tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Retrieves a list of tags applied to the specified resource.

func (ListTagsForResourceInput) MarshalFields 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags that are applied to the specified resource.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The response to the request.

func (ListTagsForResourceOutput) MarshalFields 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type OrderBy 

type OrderBy string
const (
	OrderByAsc  OrderBy = "ASC"
	OrderByDesc OrderBy = "DESC"
)

Enum values for OrderBy

func (OrderBy) MarshalValue 

func (enum OrderBy) MarshalValue() (string, error)

func (OrderBy) MarshalValueBuf 

func (enum OrderBy) MarshalValueBuf(b []byte) ([]byte, error)

type ReasonCode added in v0.21.0 

type ReasonCode string
const (
	ReasonCodeAwsServiceAccessDisabled           ReasonCode = "AWS_SERVICE_ACCESS_DISABLED"
	ReasonCodeDelegatedAdministratorDeregistered ReasonCode = "DELEGATED_ADMINISTRATOR_DEREGISTERED"
	ReasonCodeOrganizationDeleted                ReasonCode = "ORGANIZATION_DELETED"
	ReasonCodeServiceLinkedRoleCreationFailed    ReasonCode = "SERVICE_LINKED_ROLE_CREATION_FAILED"
)

Enum values for ReasonCode

func (ReasonCode) MarshalValue added in v0.21.0 

func (enum ReasonCode) MarshalValue() (string, error)

func (ReasonCode) MarshalValueBuf added in v0.21.0 

func (enum ReasonCode) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceType 

type ResourceType string
const (
	ResourceTypeAwsIamRole            ResourceType = "AWS::IAM::Role"
	ResourceTypeAwsKmsKey             ResourceType = "AWS::KMS::Key"
	ResourceTypeAwsLambdaFunction     ResourceType = "AWS::Lambda::Function"
	ResourceTypeAwsLambdaLayerVersion ResourceType = "AWS::Lambda::LayerVersion"
	ResourceTypeAwsS3Bucket           ResourceType = "AWS::S3::Bucket"
	ResourceTypeAwsSqsQueue           ResourceType = "AWS::SQS::Queue"
)

Enum values for ResourceType

func (ResourceType) MarshalValue 

func (enum ResourceType) MarshalValue() (string, error)

func (ResourceType) MarshalValueBuf 

func (enum ResourceType) MarshalValueBuf(b []byte) ([]byte, error)

type SortCriteria 

type SortCriteria struct {

	// The name of the attribute to sort on.
	AttributeName *string `locationName:"attributeName" type:"string"`

	// The sort order, ascending or descending.
	OrderBy OrderBy `locationName:"orderBy" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The criteria used to sort.

func (SortCriteria) MarshalFields 

func (s SortCriteria) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SortCriteria) String 

func (s SortCriteria) String() string

String returns the string representation

type StartResourceScanInput 

type StartResourceScanInput struct {

	// The ARN of the analyzer to use to scan the policies applied to the specified
	// resource.
	//
	// AnalyzerArn is a required field
	AnalyzerArn *string `locationName:"analyzerArn" type:"string" required:"true"`

	// The ARN of the resource to scan.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Starts a scan of the policies applied to the specified resource.

func (StartResourceScanInput) MarshalFields 

func (s StartResourceScanInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartResourceScanInput) String 

func (s StartResourceScanInput) String() string

String returns the string representation

func (*StartResourceScanInput) Validate 

func (s *StartResourceScanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartResourceScanOutput 

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

func (StartResourceScanOutput) MarshalFields 

func (s StartResourceScanOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartResourceScanOutput) String 

func (s StartResourceScanOutput) String() string

String returns the string representation

type StartResourceScanRequest 

type StartResourceScanRequest struct {
	*aws.Request
	Input *StartResourceScanInput
	Copy  func(*StartResourceScanInput) StartResourceScanRequest
}

StartResourceScanRequest is the request type for the StartResourceScan API operation.

func (StartResourceScanRequest) Send 

func (r StartResourceScanRequest) Send(ctx context.Context) (*StartResourceScanResponse, error)

Send marshals and sends the StartResourceScan API request.

type StartResourceScanResponse 

type StartResourceScanResponse struct {
	*StartResourceScanOutput
	// contains filtered or unexported fields
}

StartResourceScanResponse is the response type for the StartResourceScan API operation.

func (*StartResourceScanResponse) SDKResponseMetdata 

func (r *StartResourceScanResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartResourceScan request.

type StatusReason added in v0.21.0 

type StatusReason struct {

	// The reason code for the current status of the analyzer.
	//
	// Code is a required field
	Code ReasonCode `locationName:"code" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.

func (StatusReason) MarshalFields added in v0.21.0 

func (s StatusReason) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StatusReason) String added in v0.21.0 

func (s StatusReason) String() string

String returns the string representation

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource to add the tag to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tags to add to the resource.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Adds a tag to the specified resource.

func (TagResourceInput) MarshalFields 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

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

The response to the request.

func (TagResourceOutput) MarshalFields 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type Type 

type Type string
const (
	TypeAccount      Type = "ACCOUNT"
	TypeOrganization Type = "ORGANIZATION"
)

Enum values for Type

func (Type) MarshalValue 

func (enum Type) MarshalValue() (string, error)

func (Type) MarshalValueBuf 

func (enum Type) MarshalValueBuf(b []byte) ([]byte, error)

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource to remove the tag from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The key for the tag to add.
	//
	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Removes a tag from the specified resource.

func (UntagResourceInput) MarshalFields 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

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

The response to the request.

func (UntagResourceOutput) MarshalFields 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateArchiveRuleInput 

type UpdateArchiveRuleInput struct {

	// The name of the analyzer to update the archive rules for.
	//
	// AnalyzerName is a required field
	AnalyzerName *string `location:"uri" locationName:"analyzerName" min:"1" type:"string" required:"true"`

	// A client token.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// A filter to match for the rules to update. Only rules that match the filter
	// are updated.
	//
	// Filter is a required field
	Filter map[string]Criterion `locationName:"filter" type:"map" required:"true"`

	// The name of the rule to update.
	//
	// RuleName is a required field
	RuleName *string `location:"uri" locationName:"ruleName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updates the specified archive rule.

func (UpdateArchiveRuleInput) MarshalFields 

func (s UpdateArchiveRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateArchiveRuleInput) String 

func (s UpdateArchiveRuleInput) String() string

String returns the string representation

func (*UpdateArchiveRuleInput) Validate 

func (s *UpdateArchiveRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateArchiveRuleOutput 

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

func (UpdateArchiveRuleOutput) MarshalFields 

func (s UpdateArchiveRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateArchiveRuleOutput) String 

func (s UpdateArchiveRuleOutput) String() string

String returns the string representation

type UpdateArchiveRuleRequest 

type UpdateArchiveRuleRequest struct {
	*aws.Request
	Input *UpdateArchiveRuleInput
	Copy  func(*UpdateArchiveRuleInput) UpdateArchiveRuleRequest
}

UpdateArchiveRuleRequest is the request type for the UpdateArchiveRule API operation.

func (UpdateArchiveRuleRequest) Send 

func (r UpdateArchiveRuleRequest) Send(ctx context.Context) (*UpdateArchiveRuleResponse, error)

Send marshals and sends the UpdateArchiveRule API request.

type UpdateArchiveRuleResponse 

type UpdateArchiveRuleResponse struct {
	*UpdateArchiveRuleOutput
	// contains filtered or unexported fields
}

UpdateArchiveRuleResponse is the response type for the UpdateArchiveRule API operation.

func (*UpdateArchiveRuleResponse) SDKResponseMetdata 

func (r *UpdateArchiveRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateArchiveRule request.

type UpdateFindingsInput 

type UpdateFindingsInput struct {

	// The ARN of the analyzer that generated the findings to update.
	//
	// AnalyzerArn is a required field
	AnalyzerArn *string `locationName:"analyzerArn" type:"string" required:"true"`

	// A client token.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The IDs of the findings to update.
	Ids []string `locationName:"ids" type:"list"`

	// The ARN of the resource identified in the finding.
	ResourceArn *string `locationName:"resourceArn" type:"string"`

	// The state represents the action to take to update the finding Status. Use
	// ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to
	// change an Archived finding to an Active finding.
	//
	// Status is a required field
	Status FindingStatusUpdate `locationName:"status" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Updates findings with the new values provided in the request.

func (UpdateFindingsInput) MarshalFields 

func (s UpdateFindingsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFindingsInput) String 

func (s UpdateFindingsInput) String() string

String returns the string representation

func (*UpdateFindingsInput) Validate 

func (s *UpdateFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFindingsOutput 

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

func (UpdateFindingsOutput) MarshalFields 

func (s UpdateFindingsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFindingsOutput) String 

func (s UpdateFindingsOutput) String() string

String returns the string representation

type UpdateFindingsRequest 

type UpdateFindingsRequest struct {
	*aws.Request
	Input *UpdateFindingsInput
	Copy  func(*UpdateFindingsInput) UpdateFindingsRequest
}

UpdateFindingsRequest is the request type for the UpdateFindings API operation.

func (UpdateFindingsRequest) Send 

func (r UpdateFindingsRequest) Send(ctx context.Context) (*UpdateFindingsResponse, error)

Send marshals and sends the UpdateFindings API request.

type UpdateFindingsResponse 

type UpdateFindingsResponse struct {
	*UpdateFindingsOutput
	// contains filtered or unexported fields
}

UpdateFindingsResponse is the response type for the UpdateFindings API operation.

func (*UpdateFindingsResponse) SDKResponseMetdata 

func (r *UpdateFindingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFindings request.

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message about the validation exception.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the validation exception.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a validation exception.

func (ValidationExceptionField) MarshalFields 

func (s ValidationExceptionField) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) MarshalValue 

func (enum ValidationExceptionReason) MarshalValue() (string, error)

func (ValidationExceptionReason) MarshalValueBuf 

func (enum ValidationExceptionReason) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package accessanalyzeriface provides an interface to enable mocking the Access Analyzer service client for testing your code.
 Package accessanalyzeriface provides an interface to enable mocking the Access Analyzer service client for testing your code.

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.