auditmanager

package module
v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Jun 25, 2021 License: Apache-2.0 Imports: 27 Imported by: 8

Documentation

Overview

Package auditmanager provides the API client, operations, and parameter types for AWS Audit Manager.

Welcome to the AWS Audit Manager API reference. This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors. AWS Audit Manager is a service that provides automated evidence collection so that you can continuously audit your AWS usage, and assess the effectiveness of your controls to better manage risk and simplify compliance. AWS Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with unique requirements. Use the following links to get started with the AWS Audit Manager API:

* Actions (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html): An alphabetical list of all AWS Audit Manager API operations.

* Data types (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html): An alphabetical list of all AWS Audit Manager data types.

* Common parameters (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html): Parameters that all Query operations can use.

* Common errors (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html): Client and server errors that all operations can return.

If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide (https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html).

Index

Constants

View Source
const ServiceAPIVersion = "2017-07-25"
View Source
const ServiceID = "AuditManager"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

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

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

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

Types

type AssociateAssessmentReportEvidenceFolderInput

type AssociateAssessmentReportEvidenceFolderInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the folder in which evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string
}

type AssociateAssessmentReportEvidenceFolderOutput

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

type BatchAssociateAssessmentReportEvidenceInput

type BatchAssociateAssessmentReportEvidenceInput struct {

	// The unique identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the folder in which the evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string

	// The list of evidence identifiers.
	//
	// This member is required.
	EvidenceIds []string
}

type BatchAssociateAssessmentReportEvidenceOutput

type BatchAssociateAssessmentReportEvidenceOutput struct {

	// A list of errors returned by the BatchAssociateAssessmentReportEvidence API.
	Errors []types.AssessmentReportEvidenceError

	// The identifier for the evidence.
	EvidenceIds []string

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

type BatchCreateDelegationByAssessmentInput

type BatchCreateDelegationByAssessmentInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The API request to batch create delegations in AWS Audit Manager.
	//
	// This member is required.
	CreateDelegationRequests []types.CreateDelegationRequest
}

type BatchCreateDelegationByAssessmentOutput

type BatchCreateDelegationByAssessmentOutput struct {

	// The delegations associated with the assessment.
	Delegations []types.Delegation

	// A list of errors returned by the BatchCreateDelegationByAssessment API.
	Errors []types.BatchCreateDelegationByAssessmentError

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

type BatchDeleteDelegationByAssessmentInput

type BatchDeleteDelegationByAssessmentInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifiers for the specified delegations.
	//
	// This member is required.
	DelegationIds []string
}

type BatchDeleteDelegationByAssessmentOutput

type BatchDeleteDelegationByAssessmentOutput struct {

	// A list of errors returned by the BatchDeleteDelegationByAssessment API.
	Errors []types.BatchDeleteDelegationByAssessmentError

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

type BatchDisassociateAssessmentReportEvidenceInput

type BatchDisassociateAssessmentReportEvidenceInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the folder in which evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string

	// The list of evidence identifiers.
	//
	// This member is required.
	EvidenceIds []string
}

type BatchDisassociateAssessmentReportEvidenceOutput

type BatchDisassociateAssessmentReportEvidenceOutput struct {

	// A list of errors returned by the BatchDisassociateAssessmentReportEvidence API.
	Errors []types.AssessmentReportEvidenceError

	// The identifier for the evidence.
	EvidenceIds []string

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

type BatchImportEvidenceToAssessmentControlInput

type BatchImportEvidenceToAssessmentControlInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the specified control.
	//
	// This member is required.
	ControlId *string

	// The identifier for the specified control set.
	//
	// This member is required.
	ControlSetId *string

	// The list of manual evidence objects.
	//
	// This member is required.
	ManualEvidence []types.ManualEvidence
}

type BatchImportEvidenceToAssessmentControlOutput

type BatchImportEvidenceToAssessmentControlOutput struct {

	// A list of errors returned by the BatchImportEvidenceToAssessmentControl API.
	Errors []types.BatchImportEvidenceToAssessmentControlError

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

type Client

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

Client provides the API client to make operations call for AWS Audit Manager.

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

func (c *Client) AssociateAssessmentReportEvidenceFolder(ctx context.Context, params *AssociateAssessmentReportEvidenceFolderInput, optFns ...func(*Options)) (*AssociateAssessmentReportEvidenceFolderOutput, error)

Associates an evidence folder to the specified assessment report in AWS Audit Manager.

func (*Client) BatchAssociateAssessmentReportEvidence

func (c *Client) BatchAssociateAssessmentReportEvidence(ctx context.Context, params *BatchAssociateAssessmentReportEvidenceInput, optFns ...func(*Options)) (*BatchAssociateAssessmentReportEvidenceOutput, error)

Associates a list of evidence to an assessment report in an AWS Audit Manager assessment.

func (*Client) BatchCreateDelegationByAssessment

func (c *Client) BatchCreateDelegationByAssessment(ctx context.Context, params *BatchCreateDelegationByAssessmentInput, optFns ...func(*Options)) (*BatchCreateDelegationByAssessmentOutput, error)

Create a batch of delegations for a specified assessment in AWS Audit Manager.

func (*Client) BatchDeleteDelegationByAssessment

func (c *Client) BatchDeleteDelegationByAssessment(ctx context.Context, params *BatchDeleteDelegationByAssessmentInput, optFns ...func(*Options)) (*BatchDeleteDelegationByAssessmentOutput, error)

Deletes the delegations in the specified AWS Audit Manager assessment.

func (*Client) BatchDisassociateAssessmentReportEvidence

func (c *Client) BatchDisassociateAssessmentReportEvidence(ctx context.Context, params *BatchDisassociateAssessmentReportEvidenceInput, optFns ...func(*Options)) (*BatchDisassociateAssessmentReportEvidenceOutput, error)

Disassociates a list of evidence from the specified assessment report in AWS Audit Manager.

func (*Client) BatchImportEvidenceToAssessmentControl

func (c *Client) BatchImportEvidenceToAssessmentControl(ctx context.Context, params *BatchImportEvidenceToAssessmentControlInput, optFns ...func(*Options)) (*BatchImportEvidenceToAssessmentControlOutput, error)

Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager.

func (*Client) CreateAssessment

func (c *Client) CreateAssessment(ctx context.Context, params *CreateAssessmentInput, optFns ...func(*Options)) (*CreateAssessmentOutput, error)

Creates an assessment in AWS Audit Manager.

func (*Client) CreateAssessmentFramework

func (c *Client) CreateAssessmentFramework(ctx context.Context, params *CreateAssessmentFrameworkInput, optFns ...func(*Options)) (*CreateAssessmentFrameworkOutput, error)

Creates a custom framework in AWS Audit Manager.

func (*Client) CreateAssessmentReport

func (c *Client) CreateAssessmentReport(ctx context.Context, params *CreateAssessmentReportInput, optFns ...func(*Options)) (*CreateAssessmentReportOutput, error)

Creates an assessment report for the specified assessment.

func (*Client) CreateControl

func (c *Client) CreateControl(ctx context.Context, params *CreateControlInput, optFns ...func(*Options)) (*CreateControlOutput, error)

Creates a new custom control in AWS Audit Manager.

func (*Client) DeleteAssessment

func (c *Client) DeleteAssessment(ctx context.Context, params *DeleteAssessmentInput, optFns ...func(*Options)) (*DeleteAssessmentOutput, error)

Deletes an assessment in AWS Audit Manager.

func (*Client) DeleteAssessmentFramework

func (c *Client) DeleteAssessmentFramework(ctx context.Context, params *DeleteAssessmentFrameworkInput, optFns ...func(*Options)) (*DeleteAssessmentFrameworkOutput, error)

Deletes a custom framework in AWS Audit Manager.

func (*Client) DeleteAssessmentReport

func (c *Client) DeleteAssessmentReport(ctx context.Context, params *DeleteAssessmentReportInput, optFns ...func(*Options)) (*DeleteAssessmentReportOutput, error)

Deletes an assessment report from an assessment in AWS Audit Manager.

func (*Client) DeleteControl

func (c *Client) DeleteControl(ctx context.Context, params *DeleteControlInput, optFns ...func(*Options)) (*DeleteControlOutput, error)

Deletes a custom control in AWS Audit Manager.

func (*Client) DeregisterAccount

func (c *Client) DeregisterAccount(ctx context.Context, params *DeregisterAccountInput, optFns ...func(*Options)) (*DeregisterAccountOutput, error)

Deregisters an account in AWS Audit Manager.

func (*Client) DeregisterOrganizationAdminAccount

func (c *Client) DeregisterOrganizationAdminAccount(ctx context.Context, params *DeregisterOrganizationAdminAccountInput, optFns ...func(*Options)) (*DeregisterOrganizationAdminAccountOutput, error)

Deregisters the delegated AWS administrator account from the AWS organization.

func (*Client) DisassociateAssessmentReportEvidenceFolder

func (c *Client) DisassociateAssessmentReportEvidenceFolder(ctx context.Context, params *DisassociateAssessmentReportEvidenceFolderInput, optFns ...func(*Options)) (*DisassociateAssessmentReportEvidenceFolderOutput, error)

Disassociates an evidence folder from the specified assessment report in AWS Audit Manager.

func (*Client) GetAccountStatus

func (c *Client) GetAccountStatus(ctx context.Context, params *GetAccountStatusInput, optFns ...func(*Options)) (*GetAccountStatusOutput, error)

Returns the registration status of an account in AWS Audit Manager.

func (*Client) GetAssessment

func (c *Client) GetAssessment(ctx context.Context, params *GetAssessmentInput, optFns ...func(*Options)) (*GetAssessmentOutput, error)

Returns an assessment from AWS Audit Manager.

func (*Client) GetAssessmentFramework

func (c *Client) GetAssessmentFramework(ctx context.Context, params *GetAssessmentFrameworkInput, optFns ...func(*Options)) (*GetAssessmentFrameworkOutput, error)

Returns a framework from AWS Audit Manager.

func (*Client) GetAssessmentReportUrl

func (c *Client) GetAssessmentReportUrl(ctx context.Context, params *GetAssessmentReportUrlInput, optFns ...func(*Options)) (*GetAssessmentReportUrlOutput, error)

Returns the URL of a specified assessment report in AWS Audit Manager.

func (*Client) GetChangeLogs

func (c *Client) GetChangeLogs(ctx context.Context, params *GetChangeLogsInput, optFns ...func(*Options)) (*GetChangeLogsOutput, error)

Returns a list of changelogs from AWS Audit Manager.

func (*Client) GetControl

func (c *Client) GetControl(ctx context.Context, params *GetControlInput, optFns ...func(*Options)) (*GetControlOutput, error)

Returns a control from AWS Audit Manager.

func (*Client) GetDelegations

func (c *Client) GetDelegations(ctx context.Context, params *GetDelegationsInput, optFns ...func(*Options)) (*GetDelegationsOutput, error)

Returns a list of delegations from an audit owner to a delegate.

func (*Client) GetEvidence

func (c *Client) GetEvidence(ctx context.Context, params *GetEvidenceInput, optFns ...func(*Options)) (*GetEvidenceOutput, error)

Returns evidence from AWS Audit Manager.

func (*Client) GetEvidenceByEvidenceFolder

func (c *Client) GetEvidenceByEvidenceFolder(ctx context.Context, params *GetEvidenceByEvidenceFolderInput, optFns ...func(*Options)) (*GetEvidenceByEvidenceFolderOutput, error)

Returns all evidence from a specified evidence folder in AWS Audit Manager.

func (*Client) GetEvidenceFolder

func (c *Client) GetEvidenceFolder(ctx context.Context, params *GetEvidenceFolderInput, optFns ...func(*Options)) (*GetEvidenceFolderOutput, error)

Returns an evidence folder from the specified assessment in AWS Audit Manager.

func (*Client) GetEvidenceFoldersByAssessment

func (c *Client) GetEvidenceFoldersByAssessment(ctx context.Context, params *GetEvidenceFoldersByAssessmentInput, optFns ...func(*Options)) (*GetEvidenceFoldersByAssessmentOutput, error)

Returns the evidence folders from a specified assessment in AWS Audit Manager.

func (*Client) GetEvidenceFoldersByAssessmentControl

func (c *Client) GetEvidenceFoldersByAssessmentControl(ctx context.Context, params *GetEvidenceFoldersByAssessmentControlInput, optFns ...func(*Options)) (*GetEvidenceFoldersByAssessmentControlOutput, error)

Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager.

func (*Client) GetOrganizationAdminAccount

func (c *Client) GetOrganizationAdminAccount(ctx context.Context, params *GetOrganizationAdminAccountInput, optFns ...func(*Options)) (*GetOrganizationAdminAccountOutput, error)

Returns the name of the delegated AWS administrator account for the AWS organization.

func (*Client) GetServicesInScope

func (c *Client) GetServicesInScope(ctx context.Context, params *GetServicesInScopeInput, optFns ...func(*Options)) (*GetServicesInScopeOutput, error)

Returns a list of the in-scope AWS services for the specified assessment.

func (*Client) GetSettings

func (c *Client) GetSettings(ctx context.Context, params *GetSettingsInput, optFns ...func(*Options)) (*GetSettingsOutput, error)

Returns the settings for the specified AWS account.

func (*Client) ListAssessmentFrameworks

func (c *Client) ListAssessmentFrameworks(ctx context.Context, params *ListAssessmentFrameworksInput, optFns ...func(*Options)) (*ListAssessmentFrameworksOutput, error)

Returns a list of the frameworks available in the AWS Audit Manager framework library.

func (*Client) ListAssessmentReports

func (c *Client) ListAssessmentReports(ctx context.Context, params *ListAssessmentReportsInput, optFns ...func(*Options)) (*ListAssessmentReportsOutput, error)

Returns a list of assessment reports created in AWS Audit Manager.

func (*Client) ListAssessments

func (c *Client) ListAssessments(ctx context.Context, params *ListAssessmentsInput, optFns ...func(*Options)) (*ListAssessmentsOutput, error)

Returns a list of current and past assessments from AWS Audit Manager.

func (*Client) ListControls

func (c *Client) ListControls(ctx context.Context, params *ListControlsInput, optFns ...func(*Options)) (*ListControlsOutput, error)

Returns a list of controls from AWS Audit Manager.

func (*Client) ListKeywordsForDataSource

func (c *Client) ListKeywordsForDataSource(ctx context.Context, params *ListKeywordsForDataSourceInput, optFns ...func(*Options)) (*ListKeywordsForDataSourceOutput, error)

Returns a list of keywords that pre-mapped to the specified control data source.

func (*Client) ListNotifications

func (c *Client) ListNotifications(ctx context.Context, params *ListNotificationsInput, optFns ...func(*Options)) (*ListNotificationsOutput, error)

Returns a list of all AWS Audit Manager notifications.

func (*Client) ListTagsForResource

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

Returns a list of tags for the specified resource in AWS Audit Manager.

func (*Client) RegisterAccount

func (c *Client) RegisterAccount(ctx context.Context, params *RegisterAccountInput, optFns ...func(*Options)) (*RegisterAccountOutput, error)

Enables AWS Audit Manager for the specified AWS account.

func (*Client) RegisterOrganizationAdminAccount

func (c *Client) RegisterOrganizationAdminAccount(ctx context.Context, params *RegisterOrganizationAdminAccountInput, optFns ...func(*Options)) (*RegisterOrganizationAdminAccountOutput, error)

Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager.

func (*Client) TagResource

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

Tags the specified resource in AWS Audit Manager.

func (*Client) UntagResource

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

Removes a tag from a resource in AWS Audit Manager.

func (*Client) UpdateAssessment

func (c *Client) UpdateAssessment(ctx context.Context, params *UpdateAssessmentInput, optFns ...func(*Options)) (*UpdateAssessmentOutput, error)

Edits an AWS Audit Manager assessment.

func (*Client) UpdateAssessmentControl

func (c *Client) UpdateAssessmentControl(ctx context.Context, params *UpdateAssessmentControlInput, optFns ...func(*Options)) (*UpdateAssessmentControlOutput, error)

Updates a control within an assessment in AWS Audit Manager.

func (*Client) UpdateAssessmentControlSetStatus

func (c *Client) UpdateAssessmentControlSetStatus(ctx context.Context, params *UpdateAssessmentControlSetStatusInput, optFns ...func(*Options)) (*UpdateAssessmentControlSetStatusOutput, error)

Updates the status of a control set in an AWS Audit Manager assessment.

func (*Client) UpdateAssessmentFramework

func (c *Client) UpdateAssessmentFramework(ctx context.Context, params *UpdateAssessmentFrameworkInput, optFns ...func(*Options)) (*UpdateAssessmentFrameworkOutput, error)

Updates a custom framework in AWS Audit Manager.

func (*Client) UpdateAssessmentStatus

func (c *Client) UpdateAssessmentStatus(ctx context.Context, params *UpdateAssessmentStatusInput, optFns ...func(*Options)) (*UpdateAssessmentStatusOutput, error)

Updates the status of an assessment in AWS Audit Manager.

func (*Client) UpdateControl

func (c *Client) UpdateControl(ctx context.Context, params *UpdateControlInput, optFns ...func(*Options)) (*UpdateControlOutput, error)

Updates a custom control in AWS Audit Manager.

func (*Client) UpdateSettings

func (c *Client) UpdateSettings(ctx context.Context, params *UpdateSettingsInput, optFns ...func(*Options)) (*UpdateSettingsOutput, error)

Updates AWS Audit Manager settings for the current user account.

func (*Client) ValidateAssessmentReportIntegrity

func (c *Client) ValidateAssessmentReportIntegrity(ctx context.Context, params *ValidateAssessmentReportIntegrityInput, optFns ...func(*Options)) (*ValidateAssessmentReportIntegrityOutput, error)

Validates the integrity of an assessment report in AWS Audit Manager.

type CreateAssessmentFrameworkInput

type CreateAssessmentFrameworkInput struct {

	// The control sets to be associated with the framework.
	//
	// This member is required.
	ControlSets []types.CreateAssessmentFrameworkControlSet

	// The name of the new custom framework.
	//
	// This member is required.
	Name *string

	// The compliance type that the new custom framework supports, such as CIS or
	// HIPAA.
	ComplianceType *string

	// An optional description for the new custom framework.
	Description *string

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

type CreateAssessmentFrameworkOutput

type CreateAssessmentFrameworkOutput struct {

	// The name of the new framework returned by the CreateAssessmentFramework API.
	Framework *types.Framework

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

type CreateAssessmentInput

type CreateAssessmentInput struct {

	// The assessment report storage destination for the specified assessment that is
	// being created.
	//
	// This member is required.
	AssessmentReportsDestination *types.AssessmentReportsDestination

	// The identifier for the specified framework.
	//
	// This member is required.
	FrameworkId *string

	// The name of the assessment to be created.
	//
	// This member is required.
	Name *string

	// The list of roles for the specified assessment.
	//
	// This member is required.
	Roles []types.Role

	// The wrapper that contains the AWS accounts and AWS services in scope for the
	// assessment.
	//
	// This member is required.
	Scope *types.Scope

	// The optional description of the assessment to be created.
	Description *string

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

type CreateAssessmentOutput

type CreateAssessmentOutput struct {

	// An entity that defines the scope of audit evidence collected by AWS Audit
	// Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit
	// Manager framework.
	Assessment *types.Assessment

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

type CreateAssessmentReportInput

type CreateAssessmentReportInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The name of the new assessment report.
	//
	// This member is required.
	Name *string

	// The description of the assessment report.
	Description *string
}

type CreateAssessmentReportOutput

type CreateAssessmentReportOutput struct {

	// The new assessment report returned by the CreateAssessmentReport API.
	AssessmentReport *types.AssessmentReport

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

type CreateControlInput

type CreateControlInput struct {

	// The data mapping sources for the specified control.
	//
	// This member is required.
	ControlMappingSources []types.CreateControlMappingSource

	// The name of the control.
	//
	// This member is required.
	Name *string

	// The recommended actions to carry out if the control is not fulfilled.
	ActionPlanInstructions *string

	// The title of the action plan for remediating the control.
	ActionPlanTitle *string

	// The description of the control.
	Description *string

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

	// The steps to follow to determine if the control has been satisfied.
	TestingInformation *string
}

type CreateControlOutput

type CreateControlOutput struct {

	// The new control returned by the CreateControl API.
	Control *types.Control

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

type DeleteAssessmentFrameworkInput

type DeleteAssessmentFrameworkInput struct {

	// The identifier for the specified framework.
	//
	// This member is required.
	FrameworkId *string
}

type DeleteAssessmentFrameworkOutput

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

type DeleteAssessmentInput

type DeleteAssessmentInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string
}

type DeleteAssessmentOutput

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

type DeleteAssessmentReportInput

type DeleteAssessmentReportInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The unique identifier for the assessment report.
	//
	// This member is required.
	AssessmentReportId *string
}

type DeleteAssessmentReportOutput

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

type DeleteControlInput

type DeleteControlInput struct {

	// The identifier for the specified control.
	//
	// This member is required.
	ControlId *string
}

type DeleteControlOutput

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

type DeregisterAccountInput

type DeregisterAccountInput struct {
}

type DeregisterAccountOutput

type DeregisterAccountOutput struct {

	// The registration status of the account.
	Status types.AccountStatus

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

type DeregisterOrganizationAdminAccountInput

type DeregisterOrganizationAdminAccountInput struct {

	// The identifier for the specified administrator account.
	AdminAccountId *string
}

type DeregisterOrganizationAdminAccountOutput

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

type DisassociateAssessmentReportEvidenceFolderInput

type DisassociateAssessmentReportEvidenceFolderInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the folder in which evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string
}

type DisassociateAssessmentReportEvidenceFolderOutput

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

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

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

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

type EndpointResolverFunc

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

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

func (EndpointResolverFunc) ResolveEndpoint

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

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetAccountStatusInput

type GetAccountStatusInput struct {
}

type GetAccountStatusOutput

type GetAccountStatusOutput struct {

	// The status of the specified AWS account.
	Status types.AccountStatus

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

type GetAssessmentFrameworkInput

type GetAssessmentFrameworkInput struct {

	// The identifier for the specified framework.
	//
	// This member is required.
	FrameworkId *string
}

type GetAssessmentFrameworkOutput

type GetAssessmentFrameworkOutput struct {

	// The framework returned by the GetAssessmentFramework API.
	Framework *types.Framework

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

type GetAssessmentInput

type GetAssessmentInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string
}

type GetAssessmentOutput

type GetAssessmentOutput struct {

	// An entity that defines the scope of audit evidence collected by AWS Audit
	// Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit
	// Manager framework.
	Assessment *types.Assessment

	// The wrapper that contains the AWS Audit Manager role information of the current
	// user, such as the role type and IAM Amazon Resource Name (ARN).
	UserRole *types.Role

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

type GetAssessmentReportUrlInput

type GetAssessmentReportUrlInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the assessment report.
	//
	// This member is required.
	AssessmentReportId *string
}

type GetAssessmentReportUrlOutput

type GetAssessmentReportUrlOutput struct {

	// A uniform resource locator, used as a unique identifier to locate a resource on
	// the internet.
	PreSignedUrl *types.URL

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

type GetChangeLogsAPIClient

type GetChangeLogsAPIClient interface {
	GetChangeLogs(context.Context, *GetChangeLogsInput, ...func(*Options)) (*GetChangeLogsOutput, error)
}

GetChangeLogsAPIClient is a client that implements the GetChangeLogs operation.

type GetChangeLogsInput

type GetChangeLogsInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the specified control.
	ControlId *string

	// The identifier for the specified control set.
	ControlSetId *string

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type GetChangeLogsOutput

type GetChangeLogsOutput struct {

	// The list of user activity for the control.
	ChangeLogs []types.ChangeLog

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type GetChangeLogsPaginator

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

GetChangeLogsPaginator is a paginator for GetChangeLogs

func NewGetChangeLogsPaginator

func NewGetChangeLogsPaginator(client GetChangeLogsAPIClient, params *GetChangeLogsInput, optFns ...func(*GetChangeLogsPaginatorOptions)) *GetChangeLogsPaginator

NewGetChangeLogsPaginator returns a new GetChangeLogsPaginator

func (*GetChangeLogsPaginator) HasMorePages

func (p *GetChangeLogsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetChangeLogsPaginator) NextPage

func (p *GetChangeLogsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetChangeLogsOutput, error)

NextPage retrieves the next GetChangeLogs page.

type GetChangeLogsPaginatorOptions

type GetChangeLogsPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

GetChangeLogsPaginatorOptions is the paginator options for GetChangeLogs

type GetControlInput

type GetControlInput struct {

	// The identifier for the specified control.
	//
	// This member is required.
	ControlId *string
}

type GetControlOutput

type GetControlOutput struct {

	// The name of the control returned by the GetControl API.
	Control *types.Control

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

type GetDelegationsAPIClient

type GetDelegationsAPIClient interface {
	GetDelegations(context.Context, *GetDelegationsInput, ...func(*Options)) (*GetDelegationsOutput, error)
}

GetDelegationsAPIClient is a client that implements the GetDelegations operation.

type GetDelegationsInput

type GetDelegationsInput struct {

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type GetDelegationsOutput

type GetDelegationsOutput struct {

	// The list of delegations returned by the GetDelegations API.
	Delegations []types.DelegationMetadata

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type GetDelegationsPaginator

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

GetDelegationsPaginator is a paginator for GetDelegations

func NewGetDelegationsPaginator

func NewGetDelegationsPaginator(client GetDelegationsAPIClient, params *GetDelegationsInput, optFns ...func(*GetDelegationsPaginatorOptions)) *GetDelegationsPaginator

NewGetDelegationsPaginator returns a new GetDelegationsPaginator

func (*GetDelegationsPaginator) HasMorePages

func (p *GetDelegationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetDelegationsPaginator) NextPage

func (p *GetDelegationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetDelegationsOutput, error)

NextPage retrieves the next GetDelegations page.

type GetDelegationsPaginatorOptions

type GetDelegationsPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

GetDelegationsPaginatorOptions is the paginator options for GetDelegations

type GetEvidenceByEvidenceFolderAPIClient

type GetEvidenceByEvidenceFolderAPIClient interface {
	GetEvidenceByEvidenceFolder(context.Context, *GetEvidenceByEvidenceFolderInput, ...func(*Options)) (*GetEvidenceByEvidenceFolderOutput, error)
}

GetEvidenceByEvidenceFolderAPIClient is a client that implements the GetEvidenceByEvidenceFolder operation.

type GetEvidenceByEvidenceFolderInput

type GetEvidenceByEvidenceFolderInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the control set.
	//
	// This member is required.
	ControlSetId *string

	// The unique identifier for the folder in which the evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type GetEvidenceByEvidenceFolderOutput

type GetEvidenceByEvidenceFolderOutput struct {

	// The list of evidence returned by the GetEvidenceByEvidenceFolder API.
	Evidence []types.Evidence

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type GetEvidenceByEvidenceFolderPaginator

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

GetEvidenceByEvidenceFolderPaginator is a paginator for GetEvidenceByEvidenceFolder

func NewGetEvidenceByEvidenceFolderPaginator

NewGetEvidenceByEvidenceFolderPaginator returns a new GetEvidenceByEvidenceFolderPaginator

func (*GetEvidenceByEvidenceFolderPaginator) HasMorePages

func (p *GetEvidenceByEvidenceFolderPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEvidenceByEvidenceFolderPaginator) NextPage

NextPage retrieves the next GetEvidenceByEvidenceFolder page.

type GetEvidenceByEvidenceFolderPaginatorOptions

type GetEvidenceByEvidenceFolderPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

GetEvidenceByEvidenceFolderPaginatorOptions is the paginator options for GetEvidenceByEvidenceFolder

type GetEvidenceFolderInput

type GetEvidenceFolderInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the specified control set.
	//
	// This member is required.
	ControlSetId *string

	// The identifier for the folder in which the evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string
}

type GetEvidenceFolderOutput

type GetEvidenceFolderOutput struct {

	// The folder in which evidence is stored.
	EvidenceFolder *types.AssessmentEvidenceFolder

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

type GetEvidenceFoldersByAssessmentAPIClient

type GetEvidenceFoldersByAssessmentAPIClient interface {
	GetEvidenceFoldersByAssessment(context.Context, *GetEvidenceFoldersByAssessmentInput, ...func(*Options)) (*GetEvidenceFoldersByAssessmentOutput, error)
}

GetEvidenceFoldersByAssessmentAPIClient is a client that implements the GetEvidenceFoldersByAssessment operation.

type GetEvidenceFoldersByAssessmentControlAPIClient

type GetEvidenceFoldersByAssessmentControlAPIClient interface {
	GetEvidenceFoldersByAssessmentControl(context.Context, *GetEvidenceFoldersByAssessmentControlInput, ...func(*Options)) (*GetEvidenceFoldersByAssessmentControlOutput, error)
}

GetEvidenceFoldersByAssessmentControlAPIClient is a client that implements the GetEvidenceFoldersByAssessmentControl operation.

type GetEvidenceFoldersByAssessmentControlInput

type GetEvidenceFoldersByAssessmentControlInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the specified control.
	//
	// This member is required.
	ControlId *string

	// The identifier for the specified control set.
	//
	// This member is required.
	ControlSetId *string

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type GetEvidenceFoldersByAssessmentControlOutput

type GetEvidenceFoldersByAssessmentControlOutput struct {

	// The list of evidence folders returned by the
	// GetEvidenceFoldersByAssessmentControl API.
	EvidenceFolders []types.AssessmentEvidenceFolder

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type GetEvidenceFoldersByAssessmentControlPaginator

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

GetEvidenceFoldersByAssessmentControlPaginator is a paginator for GetEvidenceFoldersByAssessmentControl

func NewGetEvidenceFoldersByAssessmentControlPaginator

NewGetEvidenceFoldersByAssessmentControlPaginator returns a new GetEvidenceFoldersByAssessmentControlPaginator

func (*GetEvidenceFoldersByAssessmentControlPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEvidenceFoldersByAssessmentControlPaginator) NextPage

NextPage retrieves the next GetEvidenceFoldersByAssessmentControl page.

type GetEvidenceFoldersByAssessmentControlPaginatorOptions

type GetEvidenceFoldersByAssessmentControlPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

GetEvidenceFoldersByAssessmentControlPaginatorOptions is the paginator options for GetEvidenceFoldersByAssessmentControl

type GetEvidenceFoldersByAssessmentInput

type GetEvidenceFoldersByAssessmentInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type GetEvidenceFoldersByAssessmentOutput

type GetEvidenceFoldersByAssessmentOutput struct {

	// The list of evidence folders returned by the GetEvidenceFoldersByAssessment API.
	EvidenceFolders []types.AssessmentEvidenceFolder

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type GetEvidenceFoldersByAssessmentPaginator

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

GetEvidenceFoldersByAssessmentPaginator is a paginator for GetEvidenceFoldersByAssessment

func NewGetEvidenceFoldersByAssessmentPaginator

NewGetEvidenceFoldersByAssessmentPaginator returns a new GetEvidenceFoldersByAssessmentPaginator

func (*GetEvidenceFoldersByAssessmentPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEvidenceFoldersByAssessmentPaginator) NextPage

NextPage retrieves the next GetEvidenceFoldersByAssessment page.

type GetEvidenceFoldersByAssessmentPaginatorOptions

type GetEvidenceFoldersByAssessmentPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

GetEvidenceFoldersByAssessmentPaginatorOptions is the paginator options for GetEvidenceFoldersByAssessment

type GetEvidenceInput

type GetEvidenceInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the specified control set.
	//
	// This member is required.
	ControlSetId *string

	// The identifier for the folder in which the evidence is stored.
	//
	// This member is required.
	EvidenceFolderId *string

	// The identifier for the evidence.
	//
	// This member is required.
	EvidenceId *string
}

type GetEvidenceOutput

type GetEvidenceOutput struct {

	// The evidence returned by the GetEvidenceResponse API.
	Evidence *types.Evidence

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

type GetOrganizationAdminAccountInput

type GetOrganizationAdminAccountInput struct {
}

type GetOrganizationAdminAccountOutput

type GetOrganizationAdminAccountOutput struct {

	// The identifier for the specified administrator account.
	AdminAccountId *string

	// The identifier for the specified organization.
	OrganizationId *string

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

type GetServicesInScopeInput

type GetServicesInScopeInput struct {
}

type GetServicesInScopeOutput

type GetServicesInScopeOutput struct {

	// The metadata associated with the aAWS service.
	ServiceMetadata []types.ServiceMetadata

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

type GetSettingsInput

type GetSettingsInput struct {

	// The list of SettingAttribute enum values.
	//
	// This member is required.
	Attribute types.SettingAttribute
}

type GetSettingsOutput

type GetSettingsOutput struct {

	// The settings object that holds all supported AWS Audit Manager settings.
	Settings *types.Settings

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

type HTTPClient

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

type HTTPSignerV4

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

type ListAssessmentFrameworksAPIClient

type ListAssessmentFrameworksAPIClient interface {
	ListAssessmentFrameworks(context.Context, *ListAssessmentFrameworksInput, ...func(*Options)) (*ListAssessmentFrameworksOutput, error)
}

ListAssessmentFrameworksAPIClient is a client that implements the ListAssessmentFrameworks operation.

type ListAssessmentFrameworksInput

type ListAssessmentFrameworksInput struct {

	// The type of framework, such as standard or custom.
	//
	// This member is required.
	FrameworkType types.FrameworkType

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type ListAssessmentFrameworksOutput

type ListAssessmentFrameworksOutput struct {

	// The list of metadata objects for the specified framework.
	FrameworkMetadataList []types.AssessmentFrameworkMetadata

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type ListAssessmentFrameworksPaginator

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

ListAssessmentFrameworksPaginator is a paginator for ListAssessmentFrameworks

func NewListAssessmentFrameworksPaginator

NewListAssessmentFrameworksPaginator returns a new ListAssessmentFrameworksPaginator

func (*ListAssessmentFrameworksPaginator) HasMorePages

func (p *ListAssessmentFrameworksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentFrameworksPaginator) NextPage

NextPage retrieves the next ListAssessmentFrameworks page.

type ListAssessmentFrameworksPaginatorOptions

type ListAssessmentFrameworksPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

ListAssessmentFrameworksPaginatorOptions is the paginator options for ListAssessmentFrameworks

type ListAssessmentReportsAPIClient

type ListAssessmentReportsAPIClient interface {
	ListAssessmentReports(context.Context, *ListAssessmentReportsInput, ...func(*Options)) (*ListAssessmentReportsOutput, error)
}

ListAssessmentReportsAPIClient is a client that implements the ListAssessmentReports operation.

type ListAssessmentReportsInput

type ListAssessmentReportsInput struct {

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type ListAssessmentReportsOutput

type ListAssessmentReportsOutput struct {

	// The list of assessment reports returned by the ListAssessmentReports API.
	AssessmentReports []types.AssessmentReportMetadata

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type ListAssessmentReportsPaginator

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

ListAssessmentReportsPaginator is a paginator for ListAssessmentReports

func NewListAssessmentReportsPaginator

NewListAssessmentReportsPaginator returns a new ListAssessmentReportsPaginator

func (*ListAssessmentReportsPaginator) HasMorePages

func (p *ListAssessmentReportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentReportsPaginator) NextPage

NextPage retrieves the next ListAssessmentReports page.

type ListAssessmentReportsPaginatorOptions

type ListAssessmentReportsPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

ListAssessmentReportsPaginatorOptions is the paginator options for ListAssessmentReports

type ListAssessmentsAPIClient

type ListAssessmentsAPIClient interface {
	ListAssessments(context.Context, *ListAssessmentsInput, ...func(*Options)) (*ListAssessmentsOutput, error)
}

ListAssessmentsAPIClient is a client that implements the ListAssessments operation.

type ListAssessmentsInput

type ListAssessmentsInput struct {

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type ListAssessmentsOutput

type ListAssessmentsOutput struct {

	// The metadata associated with the assessment.
	AssessmentMetadata []types.AssessmentMetadataItem

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type ListAssessmentsPaginator

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

ListAssessmentsPaginator is a paginator for ListAssessments

func NewListAssessmentsPaginator

func NewListAssessmentsPaginator(client ListAssessmentsAPIClient, params *ListAssessmentsInput, optFns ...func(*ListAssessmentsPaginatorOptions)) *ListAssessmentsPaginator

NewListAssessmentsPaginator returns a new ListAssessmentsPaginator

func (*ListAssessmentsPaginator) HasMorePages

func (p *ListAssessmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentsPaginator) NextPage

func (p *ListAssessmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssessmentsOutput, error)

NextPage retrieves the next ListAssessments page.

type ListAssessmentsPaginatorOptions

type ListAssessmentsPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

ListAssessmentsPaginatorOptions is the paginator options for ListAssessments

type ListControlsAPIClient

type ListControlsAPIClient interface {
	ListControls(context.Context, *ListControlsInput, ...func(*Options)) (*ListControlsOutput, error)
}

ListControlsAPIClient is a client that implements the ListControls operation.

type ListControlsInput

type ListControlsInput struct {

	// The type of control, such as standard or custom.
	//
	// This member is required.
	ControlType types.ControlType

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type ListControlsOutput

type ListControlsOutput struct {

	// The list of control metadata objects returned by the ListControls API.
	ControlMetadataList []types.ControlMetadata

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type ListControlsPaginator

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

ListControlsPaginator is a paginator for ListControls

func NewListControlsPaginator

func NewListControlsPaginator(client ListControlsAPIClient, params *ListControlsInput, optFns ...func(*ListControlsPaginatorOptions)) *ListControlsPaginator

NewListControlsPaginator returns a new ListControlsPaginator

func (*ListControlsPaginator) HasMorePages

func (p *ListControlsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListControlsPaginator) NextPage

func (p *ListControlsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListControlsOutput, error)

NextPage retrieves the next ListControls page.

type ListControlsPaginatorOptions

type ListControlsPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

ListControlsPaginatorOptions is the paginator options for ListControls

type ListKeywordsForDataSourceAPIClient

type ListKeywordsForDataSourceAPIClient interface {
	ListKeywordsForDataSource(context.Context, *ListKeywordsForDataSourceInput, ...func(*Options)) (*ListKeywordsForDataSourceOutput, error)
}

ListKeywordsForDataSourceAPIClient is a client that implements the ListKeywordsForDataSource operation.

type ListKeywordsForDataSourceInput

type ListKeywordsForDataSourceInput struct {

	// The control mapping data source to which the keywords apply.
	//
	// This member is required.
	Source types.SourceType

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type ListKeywordsForDataSourceOutput

type ListKeywordsForDataSourceOutput struct {

	// The list of keywords for the specified event mapping source.
	Keywords []string

	// The pagination token used to fetch the next set of results.
	NextToken *string

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

type ListKeywordsForDataSourcePaginator

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

ListKeywordsForDataSourcePaginator is a paginator for ListKeywordsForDataSource

func NewListKeywordsForDataSourcePaginator

NewListKeywordsForDataSourcePaginator returns a new ListKeywordsForDataSourcePaginator

func (*ListKeywordsForDataSourcePaginator) HasMorePages

func (p *ListKeywordsForDataSourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKeywordsForDataSourcePaginator) NextPage

NextPage retrieves the next ListKeywordsForDataSource page.

type ListKeywordsForDataSourcePaginatorOptions

type ListKeywordsForDataSourcePaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

ListKeywordsForDataSourcePaginatorOptions is the paginator options for ListKeywordsForDataSource

type ListNotificationsAPIClient

type ListNotificationsAPIClient interface {
	ListNotifications(context.Context, *ListNotificationsInput, ...func(*Options)) (*ListNotificationsOutput, error)
}

ListNotificationsAPIClient is a client that implements the ListNotifications operation.

type ListNotificationsInput

type ListNotificationsInput struct {

	// Represents the maximum number of results per page, or per API request call.
	MaxResults *int32

	// The pagination token used to fetch the next set of results.
	NextToken *string
}

type ListNotificationsOutput

type ListNotificationsOutput struct {

	// The pagination token used to fetch the next set of results.
	NextToken *string

	// The returned list of notifications.
	Notifications []types.Notification

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

type ListNotificationsPaginator

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

ListNotificationsPaginator is a paginator for ListNotifications

func NewListNotificationsPaginator

func NewListNotificationsPaginator(client ListNotificationsAPIClient, params *ListNotificationsInput, optFns ...func(*ListNotificationsPaginatorOptions)) *ListNotificationsPaginator

NewListNotificationsPaginator returns a new ListNotificationsPaginator

func (*ListNotificationsPaginator) HasMorePages

func (p *ListNotificationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotificationsPaginator) NextPage

func (p *ListNotificationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNotificationsOutput, error)

NextPage retrieves the next ListNotifications page.

type ListNotificationsPaginatorOptions

type ListNotificationsPaginatorOptions struct {
	// Represents the maximum number of results per page, or per API request call.
	Limit int32

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

ListNotificationsPaginatorOptions is the paginator options for ListNotifications

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the specified resource.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The list of tags returned by the ListTagsForResource API.
	Tags map[string]string

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

type Options

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

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

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

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

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

func (Options) Copy

func (o Options) Copy() Options

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

type RegisterAccountInput

type RegisterAccountInput struct {

	// The delegated administrator account for AWS Audit Manager.
	DelegatedAdminAccount *string

	// The AWS KMS key details.
	KmsKey *string
}

type RegisterAccountOutput

type RegisterAccountOutput struct {

	// The status of the account registration request.
	Status types.AccountStatus

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

type RegisterOrganizationAdminAccountInput

type RegisterOrganizationAdminAccountInput struct {

	// The identifier for the specified delegated administrator account.
	//
	// This member is required.
	AdminAccountId *string
}

type RegisterOrganizationAdminAccountOutput

type RegisterOrganizationAdminAccountOutput struct {

	// The identifier for the specified delegated administrator account.
	AdminAccountId *string

	// The identifier for the specified AWS organization.
	OrganizationId *string

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the specified resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags to be associated with the resource.
	//
	// This member is required.
	Tags map[string]string
}

type TagResourceOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the specified resource.
	//
	// This member is required.
	ResourceArn *string

	// The name or key of the tag.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput

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

type UpdateAssessmentControlInput

type UpdateAssessmentControlInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The identifier for the specified control.
	//
	// This member is required.
	ControlId *string

	// The identifier for the specified control set.
	//
	// This member is required.
	ControlSetId *string

	// The comment body text for the specified control.
	CommentBody *string

	// The status of the specified control.
	ControlStatus types.ControlStatus
}

type UpdateAssessmentControlOutput

type UpdateAssessmentControlOutput struct {

	// The name of the updated control set returned by the UpdateAssessmentControl API.
	Control *types.AssessmentControl

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

type UpdateAssessmentControlSetStatusInput

type UpdateAssessmentControlSetStatusInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The comment related to the status update.
	//
	// This member is required.
	Comment *string

	// The identifier for the specified control set.
	//
	// This member is required.
	ControlSetId *string

	// The status of the control set that is being updated.
	//
	// This member is required.
	Status types.ControlSetStatus
}

type UpdateAssessmentControlSetStatusOutput

type UpdateAssessmentControlSetStatusOutput struct {

	// The name of the updated control set returned by the
	// UpdateAssessmentControlSetStatus API.
	ControlSet *types.AssessmentControlSet

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

type UpdateAssessmentFrameworkInput

type UpdateAssessmentFrameworkInput struct {

	// The control sets associated with the framework.
	//
	// This member is required.
	ControlSets []types.UpdateAssessmentFrameworkControlSet

	// The identifier for the specified framework.
	//
	// This member is required.
	FrameworkId *string

	// The name of the framework to be updated.
	//
	// This member is required.
	Name *string

	// The compliance type that the new custom framework supports, such as CIS or
	// HIPAA.
	ComplianceType *string

	// The description of the framework that is to be updated.
	Description *string
}

type UpdateAssessmentFrameworkOutput

type UpdateAssessmentFrameworkOutput struct {

	// The name of the specified framework.
	Framework *types.Framework

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

type UpdateAssessmentInput

type UpdateAssessmentInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The scope of the specified assessment.
	//
	// This member is required.
	Scope *types.Scope

	// The description of the specified assessment.
	AssessmentDescription *string

	// The name of the specified assessment to be updated.
	AssessmentName *string

	// The assessment report storage destination for the specified assessment that is
	// being updated.
	AssessmentReportsDestination *types.AssessmentReportsDestination

	// The list of roles for the specified assessment.
	Roles []types.Role
}

type UpdateAssessmentOutput

type UpdateAssessmentOutput struct {

	// The response object (name of the updated assessment) for the
	// UpdateAssessmentRequest API.
	Assessment *types.Assessment

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

type UpdateAssessmentStatusInput

type UpdateAssessmentStatusInput struct {

	// The identifier for the specified assessment.
	//
	// This member is required.
	AssessmentId *string

	// The current status of the specified assessment.
	//
	// This member is required.
	Status types.AssessmentStatus
}

type UpdateAssessmentStatusOutput

type UpdateAssessmentStatusOutput struct {

	// The name of the updated assessment returned by the UpdateAssessmentStatus API.
	Assessment *types.Assessment

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

type UpdateControlInput

type UpdateControlInput struct {

	// The identifier for the specified control.
	//
	// This member is required.
	ControlId *string

	// The data mapping sources for the specified control.
	//
	// This member is required.
	ControlMappingSources []types.ControlMappingSource

	// The name of the control to be updated.
	//
	// This member is required.
	Name *string

	// The recommended actions to carry out if the control is not fulfilled.
	ActionPlanInstructions *string

	// The title of the action plan for remediating the control.
	ActionPlanTitle *string

	// The optional description of the control.
	Description *string

	// The steps that to follow to determine if the control has been satisfied.
	TestingInformation *string
}

type UpdateControlOutput

type UpdateControlOutput struct {

	// The name of the updated control set returned by the UpdateControl API.
	Control *types.Control

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

type UpdateSettingsInput

type UpdateSettingsInput struct {

	// The default storage destination for assessment reports.
	DefaultAssessmentReportsDestination *types.AssessmentReportsDestination

	// A list of the default audit owners.
	DefaultProcessOwners []types.Role

	// The AWS KMS key details.
	KmsKey *string

	// The Amazon Simple Notification Service (Amazon SNS) topic to which AWS Audit
	// Manager sends notifications.
	SnsTopic *string
}

type UpdateSettingsOutput

type UpdateSettingsOutput struct {

	// The current list of settings.
	Settings *types.Settings

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

type ValidateAssessmentReportIntegrityInput

type ValidateAssessmentReportIntegrityInput struct {

	// The relative path of the specified Amazon S3 bucket in which the assessment
	// report is stored.
	//
	// This member is required.
	S3RelativePath *string
}

type ValidateAssessmentReportIntegrityOutput

type ValidateAssessmentReportIntegrityOutput struct {

	// The signature algorithm used to code sign the assessment report file.
	SignatureAlgorithm *string

	// The date and time signature that specifies when the assessment report was
	// created.
	SignatureDateTime *string

	// The unique identifier for the validation signature key.
	SignatureKeyId *string

	// Specifies whether the signature key is valid.
	SignatureValid *bool

	// Represents any errors that occurred when validating the assessment report.
	ValidationErrors []string

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

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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