auditmanager

package module
v1.32.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 38 Imported by: 8

Documentation

Overview

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

Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors. Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance. Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls 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 specific requirements. Use the following links to get started with the Audit Manager API:

If you're new to Audit Manager, we recommend that you review the 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 deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.26.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.29.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.29.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateAssessmentReportEvidenceFolderInput

type AssociateAssessmentReportEvidenceFolderInput struct {

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

	// The identifier for the folder that the evidence is stored in.
	//
	// This member is required.
	EvidenceFolderId *string
	// contains filtered or unexported fields
}

type AssociateAssessmentReportEvidenceFolderOutput

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

type AuthResolverParameters added in v1.29.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.29.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchAssociateAssessmentReportEvidenceInput

type BatchAssociateAssessmentReportEvidenceInput struct {

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

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

	// The list of evidence identifiers.
	//
	// This member is required.
	EvidenceIds []string
	// contains filtered or unexported fields
}

type BatchAssociateAssessmentReportEvidenceOutput

type BatchAssociateAssessmentReportEvidenceOutput struct {

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

	// The list of evidence identifiers.
	EvidenceIds []string

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

type BatchCreateDelegationByAssessmentInput

type BatchCreateDelegationByAssessmentInput struct {

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

	// The API request to batch create delegations in Audit Manager.
	//
	// This member is required.
	CreateDelegationRequests []types.CreateDelegationRequest
	// contains filtered or unexported fields
}

type BatchCreateDelegationByAssessmentOutput

type BatchCreateDelegationByAssessmentOutput struct {

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

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

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

type BatchDeleteDelegationByAssessmentInput

type BatchDeleteDelegationByAssessmentInput struct {

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

	// The identifiers for the delegations.
	//
	// This member is required.
	DelegationIds []string
	// contains filtered or unexported fields
}

type BatchDeleteDelegationByAssessmentOutput

type BatchDeleteDelegationByAssessmentOutput struct {

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

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

type BatchDisassociateAssessmentReportEvidenceInput

type BatchDisassociateAssessmentReportEvidenceInput struct {

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

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

	// The list of evidence identifiers.
	//
	// This member is required.
	EvidenceIds []string
	// contains filtered or unexported fields
}

type BatchDisassociateAssessmentReportEvidenceOutput

type BatchDisassociateAssessmentReportEvidenceOutput struct {

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

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

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

type BatchImportEvidenceToAssessmentControlInput

type BatchImportEvidenceToAssessmentControlInput struct {

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

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

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

	// The list of manual evidence objects.
	//
	// This member is required.
	ManualEvidence []types.ManualEvidence
	// contains filtered or unexported fields
}

type BatchImportEvidenceToAssessmentControlOutput

type BatchImportEvidenceToAssessmentControlOutput struct {

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

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

type Client

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

Client provides the API client to make operations call for 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 an assessment report in an Audit Manager assessment.

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 Audit Manager assessment.

func (*Client) BatchCreateDelegationByAssessment

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

Creates a batch of delegations for an assessment in Audit Manager.

func (*Client) BatchDeleteDelegationByAssessment

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

Deletes a batch of delegations for an assessment in Audit Manager.

func (*Client) BatchDisassociateAssessmentReportEvidence

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

Disassociates a list of evidence from an assessment report in Audit Manager.

func (*Client) BatchImportEvidenceToAssessmentControl

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

Adds one or more pieces of evidence to a control in an Audit Manager assessment. You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question. The following restrictions apply to this action:

For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html) .

func (*Client) CreateAssessment

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

Creates an assessment in Audit Manager.

func (*Client) CreateAssessmentFramework

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

Creates a custom framework in 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 Audit Manager.

func (*Client) DeleteAssessment

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

Deletes an assessment in Audit Manager.

func (*Client) DeleteAssessmentFramework

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

Deletes a custom framework in Audit Manager.

func (*Client) DeleteAssessmentFrameworkShare added in v1.11.0

func (c *Client) DeleteAssessmentFrameworkShare(ctx context.Context, params *DeleteAssessmentFrameworkShareInput, optFns ...func(*Options)) (*DeleteAssessmentFrameworkShareOutput, error)

Deletes a share request for a custom framework in Audit Manager.

func (*Client) DeleteAssessmentReport

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

Deletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data:

  • The specified assessment report that’s stored in your S3 bucket
  • The associated metadata that’s stored in Audit Manager

If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions (https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination) in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found ) error from Amazon S3, see List of Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) in the Amazon Simple Storage Service API Reference.

func (*Client) DeleteControl

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

Deletes a custom control in Audit Manager. When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control.

func (*Client) DeregisterAccount

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

Deregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html) API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection (https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) in the Audit Manager User Guide.

func (*Client) DeregisterOrganizationAdminAccount

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

Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager. When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward. Keep in mind the following cleanup task if you use evidence finder: Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html) . This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager ignores an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it. When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions:

At this time, Audit Manager doesn't provide an option to delete evidence for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration.

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 Audit Manager.

func (*Client) GetAccountStatus

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

Gets the registration status of an account in Audit Manager.

func (*Client) GetAssessment

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

Gets information about a specified assessment.

func (*Client) GetAssessmentFramework

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

Gets information about a specified framework.

func (*Client) GetAssessmentReportUrl

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

Gets the URL of an assessment report in Audit Manager.

func (*Client) GetChangeLogs

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

Gets a list of changelogs from Audit Manager.

func (*Client) GetControl

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

Gets information about a specified control.

func (*Client) GetDelegations

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

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

Gets information about a specified evidence item.

func (*Client) GetEvidenceByEvidenceFolder

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

Gets all evidence from a specified evidence folder in Audit Manager.

func (*Client) GetEvidenceFileUploadUrl added in v1.25.0

func (c *Client) GetEvidenceFileUploadUrl(ctx context.Context, params *GetEvidenceFileUploadUrlInput, optFns ...func(*Options)) (*GetEvidenceFileUploadUrlOutput, error)

Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser (https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files) in the Audit Manager User Guide. The following restrictions apply to this operation:

For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html) .

func (*Client) GetEvidenceFolder

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

Gets an evidence folder from a specified assessment in Audit Manager.

func (*Client) GetEvidenceFoldersByAssessment

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

Gets the evidence folders from a specified assessment in Audit Manager.

func (*Client) GetEvidenceFoldersByAssessmentControl

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

Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.

func (*Client) GetInsights added in v1.12.0

func (c *Client) GetInsights(ctx context.Context, params *GetInsightsInput, optFns ...func(*Options)) (*GetInsightsOutput, error)

Gets the latest analytics data for all your current active assessments.

func (*Client) GetInsightsByAssessment added in v1.12.0

func (c *Client) GetInsightsByAssessment(ctx context.Context, params *GetInsightsByAssessmentInput, optFns ...func(*Options)) (*GetInsightsByAssessmentOutput, error)

Gets the latest analytics data for a specific active assessment.

func (*Client) GetOrganizationAdminAccount

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

Gets the name of the delegated Amazon Web Services administrator account for a specified organization.

func (*Client) GetServicesInScope

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

Gets a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an assessment (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html) , specify which of these services you want to include to narrow the assessment's scope (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Scope.html) .

func (*Client) GetSettings

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

Gets the settings for a specified Amazon Web Services account.

func (*Client) ListAssessmentControlInsightsByControlDomain added in v1.12.0

func (c *Client) ListAssessmentControlInsightsByControlDomain(ctx context.Context, params *ListAssessmentControlInsightsByControlDomainInput, optFns ...func(*Options)) (*ListAssessmentControlInsightsByControlDomainOutput, error)

Lists the latest analytics data for controls within a specific control domain and a specific active assessment. Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment . If neither of these conditions are met, no data is listed for that control.

func (*Client) ListAssessmentFrameworkShareRequests added in v1.11.0

func (c *Client) ListAssessmentFrameworkShareRequests(ctx context.Context, params *ListAssessmentFrameworkShareRequestsInput, optFns ...func(*Options)) (*ListAssessmentFrameworkShareRequestsOutput, error)

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

func (*Client) ListAssessmentFrameworks

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

Returns a list of the frameworks that are available in the 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 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 Audit Manager.

func (*Client) ListControlDomainInsights added in v1.12.0

func (c *Client) ListControlDomainInsights(ctx context.Context, params *ListControlDomainInsightsInput, optFns ...func(*Options)) (*ListControlDomainInsightsOutput, error)

Lists the latest analytics data for control domains across all of your active assessments. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights . If this condition isn’t met, no data is listed for that control domain.

func (*Client) ListControlDomainInsightsByAssessment added in v1.12.0

func (c *Client) ListControlDomainInsightsByAssessment(ctx context.Context, params *ListControlDomainInsightsByAssessmentInput, optFns ...func(*Options)) (*ListControlDomainInsightsByAssessmentOutput, error)

Lists analytics data for control domains within a specified active assessment. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights . If this condition isn’t met, no data is listed for that domain.

func (*Client) ListControlInsightsByControlDomain added in v1.12.0

func (c *Client) ListControlInsightsByControlDomain(ctx context.Context, params *ListControlInsightsByControlDomainInput, optFns ...func(*Options)) (*ListControlInsightsByControlDomainOutput, error)

Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata . If neither of these conditions are met, no data is listed for that control.

func (*Client) ListControls

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

Returns a list of controls from 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 are 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 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 Audit Manager.

func (*Client) Options added in v1.30.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) RegisterAccount

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

Enables Audit Manager for the specified Amazon Web Services account.

func (*Client) RegisterOrganizationAdminAccount

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

Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

func (*Client) StartAssessmentFrameworkShare added in v1.11.0

func (c *Client) StartAssessmentFrameworkShare(ctx context.Context, params *StartAssessmentFrameworkShareInput, optFns ...func(*Options)) (*StartAssessmentFrameworkShareOutput, error)

Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs:

  • The sender revokes the share request.
  • The recipient declines the share request.
  • The recipient encounters an error and doesn't successfully accept the share request.
  • The share request expires before the recipient responds to the request.

When a sender resends a share request (https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend) , the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility (https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility) in the Audit Manager User Guide.

func (*Client) TagResource

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

Tags the specified resource in 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 Audit Manager.

func (*Client) UpdateAssessment

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

Edits an 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 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 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 Audit Manager.

func (*Client) UpdateAssessmentFrameworkShare added in v1.11.0

func (c *Client) UpdateAssessmentFrameworkShare(ctx context.Context, params *UpdateAssessmentFrameworkShareInput, optFns ...func(*Options)) (*UpdateAssessmentFrameworkShareOutput, error)

Updates a share request for a custom framework in 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 Audit Manager.

func (*Client) UpdateControl

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

Updates a custom control in Audit Manager.

func (*Client) UpdateSettings

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

Updates Audit Manager settings for the current 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 Audit Manager.

type CreateAssessmentFrameworkInput

type CreateAssessmentFrameworkInput struct {

	// The control sets that are 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 that are associated with the framework.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAssessmentFrameworkOutput

type CreateAssessmentFrameworkOutput struct {

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

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

type CreateAssessmentInput

type CreateAssessmentInput struct {

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

	// The identifier for the framework that the assessment will be created from.
	//
	// 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 assessment.
	//
	// This member is required.
	Roles []types.Role

	// The wrapper that contains the Amazon Web Services accounts and services that
	// are 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 that are associated with the assessment.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAssessmentOutput

type CreateAssessmentOutput struct {

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

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

type CreateAssessmentReportInput

type CreateAssessmentReportInput struct {

	// The identifier for the 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

	// A SQL statement that represents an evidence finder query. Provide this
	// parameter when you want to generate an assessment report from the results of an
	// evidence finder search query. When you use this parameter, Audit Manager
	// generates a one-time report using only the evidence from the query output. This
	// report does not include any assessment evidence that was manually added to a
	// report using the console (https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence)
	// , or associated with a report using the API (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html)
	// . To use this parameter, the enablementStatus (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus)
	// of evidence finder must be ENABLED . For examples and help resolving
	// queryStatement validation exceptions, see Troubleshooting evidence finder issues (https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions)
	// in the Audit Manager User Guide.
	QueryStatement *string
	// contains filtered or unexported fields
}

type CreateAssessmentReportOutput

type CreateAssessmentReportOutput struct {

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

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

type CreateControlInput

type CreateControlInput struct {

	// The data mapping sources for the 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 isn't fulfilled.
	ActionPlanInstructions *string

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

	// The description of the control.
	Description *string

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

	// The steps to follow to determine if the control is satisfied.
	TestingInformation *string
	// contains filtered or unexported fields
}

type CreateControlOutput

type CreateControlOutput struct {

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

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

type DeleteAssessmentFrameworkInput

type DeleteAssessmentFrameworkInput struct {

	// The identifier for the custom framework.
	//
	// This member is required.
	FrameworkId *string
	// contains filtered or unexported fields
}

type DeleteAssessmentFrameworkOutput

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

type DeleteAssessmentFrameworkShareInput added in v1.11.0

type DeleteAssessmentFrameworkShareInput struct {

	// The unique identifier for the share request to be deleted.
	//
	// This member is required.
	RequestId *string

	// Specifies whether the share request is a sent request or a received request.
	//
	// This member is required.
	RequestType types.ShareRequestType
	// contains filtered or unexported fields
}

type DeleteAssessmentFrameworkShareOutput added in v1.11.0

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

type DeleteAssessmentInput

type DeleteAssessmentInput struct {

	// The identifier for the assessment.
	//
	// This member is required.
	AssessmentId *string
	// contains filtered or unexported fields
}

type DeleteAssessmentOutput

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

type DeleteAssessmentReportInput

type DeleteAssessmentReportInput struct {

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

	// The unique identifier for the assessment report.
	//
	// This member is required.
	AssessmentReportId *string
	// contains filtered or unexported fields
}

type DeleteAssessmentReportOutput

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

type DeleteControlInput

type DeleteControlInput struct {

	// The unique identifier for the control.
	//
	// This member is required.
	ControlId *string
	// contains filtered or unexported fields
}

type DeleteControlOutput

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

type DeregisterAccountInput

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

type DeregisterAccountOutput

type DeregisterAccountOutput struct {

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

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

type DeregisterOrganizationAdminAccountInput

type DeregisterOrganizationAdminAccountInput struct {

	// The identifier for the administrator account.
	AdminAccountId *string
	// contains filtered or unexported fields
}

type DeregisterOrganizationAdminAccountOutput

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

type DisassociateAssessmentReportEvidenceFolderInput

type DisassociateAssessmentReportEvidenceFolderInput struct {

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

	// The unique identifier for the folder that the evidence is stored in.
	//
	// This member is required.
	EvidenceFolderId *string
	// contains filtered or unexported fields
}

type DisassociateAssessmentReportEvidenceFolderOutput

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

type EndpointParameters added in v1.26.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.26.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.26.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 added in v1.26.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.26.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountStatusInput

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

type GetAccountStatusOutput

type GetAccountStatusOutput struct {

	// The status of the Amazon Web Services account.
	Status types.AccountStatus

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

type GetAssessmentFrameworkInput

type GetAssessmentFrameworkInput struct {

	// The identifier for the framework.
	//
	// This member is required.
	FrameworkId *string
	// contains filtered or unexported fields
}

type GetAssessmentFrameworkOutput

type GetAssessmentFrameworkOutput struct {

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

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

type GetAssessmentInput

type GetAssessmentInput struct {

	// The unique identifier for the assessment.
	//
	// This member is required.
	AssessmentId *string
	// contains filtered or unexported fields
}

type GetAssessmentOutput

type GetAssessmentOutput struct {

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

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

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

type GetAssessmentReportUrlInput

type GetAssessmentReportUrlInput struct {

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

	// The unique identifier for the assessment report.
	//
	// This member is required.
	AssessmentReportId *string
	// contains filtered or unexported fields
}

type GetAssessmentReportUrlOutput

type GetAssessmentReportUrlOutput struct {

	// Short for uniform resource locator. A URL is 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
	// contains filtered or unexported fields
}

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 unique identifier for the assessment.
	//
	// This member is required.
	AssessmentId *string

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

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

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetChangeLogsOutput

type GetChangeLogsOutput struct {

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

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

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

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 on a page or for an 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 control.
	//
	// This member is required.
	ControlId *string
	// contains filtered or unexported fields
}

type GetControlOutput

type GetControlOutput struct {

	// The details of the control that the GetControl API returned.
	Control *types.Control

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

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 on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetDelegationsOutput

type GetDelegationsOutput struct {

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

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

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

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 on a page or for an 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 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 that the evidence is stored in.
	//
	// This member is required.
	EvidenceFolderId *string

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetEvidenceByEvidenceFolderOutput

type GetEvidenceByEvidenceFolderOutput struct {

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

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

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

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 on a page or for an 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 GetEvidenceFileUploadUrlInput added in v1.25.0

type GetEvidenceFileUploadUrlInput struct {

	// The file that you want to upload. For a list of supported file formats, see
	// Supported file types for manual evidence (https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files)
	// in the Audit Manager User Guide.
	//
	// This member is required.
	FileName *string
	// contains filtered or unexported fields
}

type GetEvidenceFileUploadUrlOutput added in v1.25.0

type GetEvidenceFileUploadUrlOutput struct {

	// The name of the uploaded manual evidence file that the presigned URL was
	// generated for.
	EvidenceFileName *string

	// The presigned URL that was generated.
	UploadUrl *string

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

type GetEvidenceFolderInput

type GetEvidenceFolderInput struct {

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

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

	// The unique identifier for the folder that the evidence is stored in.
	//
	// This member is required.
	EvidenceFolderId *string
	// contains filtered or unexported fields
}

type GetEvidenceFolderOutput

type GetEvidenceFolderOutput struct {

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

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

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 assessment.
	//
	// This member is required.
	AssessmentId *string

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

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

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetEvidenceFoldersByAssessmentControlOutput

type GetEvidenceFoldersByAssessmentControlOutput struct {

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

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

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

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 on a page or for an 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 unique identifier for the assessment.
	//
	// This member is required.
	AssessmentId *string

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetEvidenceFoldersByAssessmentOutput

type GetEvidenceFoldersByAssessmentOutput struct {

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

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

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

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 on a page or for an 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 unique identifier for the assessment.
	//
	// This member is required.
	AssessmentId *string

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

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

	// The unique identifier for the evidence.
	//
	// This member is required.
	EvidenceId *string
	// contains filtered or unexported fields
}

type GetEvidenceOutput

type GetEvidenceOutput struct {

	// The evidence that the GetEvidence API returned.
	Evidence *types.Evidence

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

type GetInsightsByAssessmentInput added in v1.12.0

type GetInsightsByAssessmentInput struct {

	// The unique identifier for the assessment.
	//
	// This member is required.
	AssessmentId *string
	// contains filtered or unexported fields
}

type GetInsightsByAssessmentOutput added in v1.12.0

type GetInsightsByAssessmentOutput struct {

	// The assessment analytics data that the GetInsightsByAssessment API returned.
	Insights *types.InsightsByAssessment

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

type GetInsightsInput added in v1.12.0

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

type GetInsightsOutput added in v1.12.0

type GetInsightsOutput struct {

	// The analytics data that the GetInsights API returned.
	Insights *types.Insights

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

type GetOrganizationAdminAccountInput

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

type GetOrganizationAdminAccountOutput

type GetOrganizationAdminAccountOutput struct {

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

	// The identifier for the organization.
	OrganizationId *string

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

type GetServicesInScopeInput

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

type GetServicesInScopeOutput

type GetServicesInScopeOutput struct {

	// The metadata that's associated with the Amazon Web Service.
	ServiceMetadata []types.ServiceMetadata

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

type GetSettingsInput

type GetSettingsInput struct {

	// The list of setting attribute enum values.
	//
	// This member is required.
	Attribute types.SettingAttribute
	// contains filtered or unexported fields
}

type GetSettingsOutput

type GetSettingsOutput struct {

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

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

type HTTPClient

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

type HTTPSignerV4

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

type ListAssessmentControlInsightsByControlDomainAPIClient added in v1.12.0

type ListAssessmentControlInsightsByControlDomainAPIClient interface {
	ListAssessmentControlInsightsByControlDomain(context.Context, *ListAssessmentControlInsightsByControlDomainInput, ...func(*Options)) (*ListAssessmentControlInsightsByControlDomainOutput, error)
}

ListAssessmentControlInsightsByControlDomainAPIClient is a client that implements the ListAssessmentControlInsightsByControlDomain operation.

type ListAssessmentControlInsightsByControlDomainInput added in v1.12.0

type ListAssessmentControlInsightsByControlDomainInput struct {

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

	// The unique identifier for the control domain.
	//
	// This member is required.
	ControlDomainId *string

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssessmentControlInsightsByControlDomainOutput added in v1.12.0

type ListAssessmentControlInsightsByControlDomainOutput struct {

	// The assessment control analytics data that the
	// ListAssessmentControlInsightsByControlDomain API returned.
	ControlInsightsByAssessment []types.ControlInsightsMetadataByAssessmentItem

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

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

type ListAssessmentControlInsightsByControlDomainPaginator added in v1.12.0

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

ListAssessmentControlInsightsByControlDomainPaginator is a paginator for ListAssessmentControlInsightsByControlDomain

func NewListAssessmentControlInsightsByControlDomainPaginator added in v1.12.0

NewListAssessmentControlInsightsByControlDomainPaginator returns a new ListAssessmentControlInsightsByControlDomainPaginator

func (*ListAssessmentControlInsightsByControlDomainPaginator) HasMorePages added in v1.12.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentControlInsightsByControlDomainPaginator) NextPage added in v1.12.0

NextPage retrieves the next ListAssessmentControlInsightsByControlDomain page.

type ListAssessmentControlInsightsByControlDomainPaginatorOptions added in v1.12.0

type ListAssessmentControlInsightsByControlDomainPaginatorOptions struct {
	// Represents the maximum number of results on a page or for an 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
}

ListAssessmentControlInsightsByControlDomainPaginatorOptions is the paginator options for ListAssessmentControlInsightsByControlDomain

type ListAssessmentFrameworkShareRequestsAPIClient added in v1.11.0

type ListAssessmentFrameworkShareRequestsAPIClient interface {
	ListAssessmentFrameworkShareRequests(context.Context, *ListAssessmentFrameworkShareRequestsInput, ...func(*Options)) (*ListAssessmentFrameworkShareRequestsOutput, error)
}

ListAssessmentFrameworkShareRequestsAPIClient is a client that implements the ListAssessmentFrameworkShareRequests operation.

type ListAssessmentFrameworkShareRequestsInput added in v1.11.0

type ListAssessmentFrameworkShareRequestsInput struct {

	// Specifies whether the share request is a sent request or a received request.
	//
	// This member is required.
	RequestType types.ShareRequestType

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssessmentFrameworkShareRequestsOutput added in v1.11.0

type ListAssessmentFrameworkShareRequestsOutput struct {

	// The list of share requests that the ListAssessmentFrameworkShareRequests API
	// returned.
	AssessmentFrameworkShareRequests []types.AssessmentFrameworkShareRequest

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

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

type ListAssessmentFrameworkShareRequestsPaginator added in v1.11.0

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

ListAssessmentFrameworkShareRequestsPaginator is a paginator for ListAssessmentFrameworkShareRequests

func NewListAssessmentFrameworkShareRequestsPaginator added in v1.11.0

NewListAssessmentFrameworkShareRequestsPaginator returns a new ListAssessmentFrameworkShareRequestsPaginator

func (*ListAssessmentFrameworkShareRequestsPaginator) HasMorePages added in v1.11.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssessmentFrameworkShareRequestsPaginator) NextPage added in v1.11.0

NextPage retrieves the next ListAssessmentFrameworkShareRequests page.

type ListAssessmentFrameworkShareRequestsPaginatorOptions added in v1.11.0

type ListAssessmentFrameworkShareRequestsPaginatorOptions struct {
	// Represents the maximum number of results on a page or for an 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
}

ListAssessmentFrameworkShareRequestsPaginatorOptions is the paginator options for ListAssessmentFrameworkShareRequests

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 a standard framework or a custom framework.
	//
	// This member is required.
	FrameworkType types.FrameworkType

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssessmentFrameworksOutput

type ListAssessmentFrameworksOutput struct {

	// A list of metadata that the ListAssessmentFrameworks API returns for each
	// framework.
	FrameworkMetadataList []types.AssessmentFrameworkMetadata

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

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

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 on a page or for an 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 on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssessmentReportsOutput

type ListAssessmentReportsOutput struct {

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

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

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

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 on a page or for an 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 on a page or for an API request call.
	MaxResults *int32

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

	// The current status of the assessment.
	Status types.AssessmentStatus
	// contains filtered or unexported fields
}

type ListAssessmentsOutput

type ListAssessmentsOutput struct {

	// The metadata that the ListAssessments API returns for each assessment.
	AssessmentMetadata []types.AssessmentMetadataItem

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

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

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 on a page or for an 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 ListControlDomainInsightsAPIClient added in v1.12.0

type ListControlDomainInsightsAPIClient interface {
	ListControlDomainInsights(context.Context, *ListControlDomainInsightsInput, ...func(*Options)) (*ListControlDomainInsightsOutput, error)
}

ListControlDomainInsightsAPIClient is a client that implements the ListControlDomainInsights operation.

type ListControlDomainInsightsByAssessmentAPIClient added in v1.12.0

type ListControlDomainInsightsByAssessmentAPIClient interface {
	ListControlDomainInsightsByAssessment(context.Context, *ListControlDomainInsightsByAssessmentInput, ...func(*Options)) (*ListControlDomainInsightsByAssessmentOutput, error)
}

ListControlDomainInsightsByAssessmentAPIClient is a client that implements the ListControlDomainInsightsByAssessment operation.

type ListControlDomainInsightsByAssessmentInput added in v1.12.0

type ListControlDomainInsightsByAssessmentInput struct {

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

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListControlDomainInsightsByAssessmentOutput added in v1.12.0

type ListControlDomainInsightsByAssessmentOutput struct {

	// The control domain analytics data that the ListControlDomainInsightsByAssessment
	// API returned.
	ControlDomainInsights []types.ControlDomainInsights

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

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

type ListControlDomainInsightsByAssessmentPaginator added in v1.12.0

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

ListControlDomainInsightsByAssessmentPaginator is a paginator for ListControlDomainInsightsByAssessment

func NewListControlDomainInsightsByAssessmentPaginator added in v1.12.0

NewListControlDomainInsightsByAssessmentPaginator returns a new ListControlDomainInsightsByAssessmentPaginator

func (*ListControlDomainInsightsByAssessmentPaginator) HasMorePages added in v1.12.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListControlDomainInsightsByAssessmentPaginator) NextPage added in v1.12.0

NextPage retrieves the next ListControlDomainInsightsByAssessment page.

type ListControlDomainInsightsByAssessmentPaginatorOptions added in v1.12.0

type ListControlDomainInsightsByAssessmentPaginatorOptions struct {
	// Represents the maximum number of results on a page or for an 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
}

ListControlDomainInsightsByAssessmentPaginatorOptions is the paginator options for ListControlDomainInsightsByAssessment

type ListControlDomainInsightsInput added in v1.12.0

type ListControlDomainInsightsInput struct {

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListControlDomainInsightsOutput added in v1.12.0

type ListControlDomainInsightsOutput struct {

	// The control domain analytics data that the ListControlDomainInsights API
	// returned.
	ControlDomainInsights []types.ControlDomainInsights

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

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

type ListControlDomainInsightsPaginator added in v1.12.0

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

ListControlDomainInsightsPaginator is a paginator for ListControlDomainInsights

func NewListControlDomainInsightsPaginator added in v1.12.0

NewListControlDomainInsightsPaginator returns a new ListControlDomainInsightsPaginator

func (*ListControlDomainInsightsPaginator) HasMorePages added in v1.12.0

func (p *ListControlDomainInsightsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListControlDomainInsightsPaginator) NextPage added in v1.12.0

NextPage retrieves the next ListControlDomainInsights page.

type ListControlDomainInsightsPaginatorOptions added in v1.12.0

type ListControlDomainInsightsPaginatorOptions struct {
	// Represents the maximum number of results on a page or for an 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
}

ListControlDomainInsightsPaginatorOptions is the paginator options for ListControlDomainInsights

type ListControlInsightsByControlDomainAPIClient added in v1.12.0

type ListControlInsightsByControlDomainAPIClient interface {
	ListControlInsightsByControlDomain(context.Context, *ListControlInsightsByControlDomainInput, ...func(*Options)) (*ListControlInsightsByControlDomainOutput, error)
}

ListControlInsightsByControlDomainAPIClient is a client that implements the ListControlInsightsByControlDomain operation.

type ListControlInsightsByControlDomainInput added in v1.12.0

type ListControlInsightsByControlDomainInput struct {

	// The unique identifier for the control domain.
	//
	// This member is required.
	ControlDomainId *string

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListControlInsightsByControlDomainOutput added in v1.12.0

type ListControlInsightsByControlDomainOutput struct {

	// The control analytics data that the ListControlInsightsByControlDomain API
	// returned.
	ControlInsightsMetadata []types.ControlInsightsMetadataItem

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

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

type ListControlInsightsByControlDomainPaginator added in v1.12.0

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

ListControlInsightsByControlDomainPaginator is a paginator for ListControlInsightsByControlDomain

func NewListControlInsightsByControlDomainPaginator added in v1.12.0

NewListControlInsightsByControlDomainPaginator returns a new ListControlInsightsByControlDomainPaginator

func (*ListControlInsightsByControlDomainPaginator) HasMorePages added in v1.12.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListControlInsightsByControlDomainPaginator) NextPage added in v1.12.0

NextPage retrieves the next ListControlInsightsByControlDomain page.

type ListControlInsightsByControlDomainPaginatorOptions added in v1.12.0

type ListControlInsightsByControlDomainPaginatorOptions struct {
	// Represents the maximum number of results on a page or for an 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
}

ListControlInsightsByControlDomainPaginatorOptions is the paginator options for ListControlInsightsByControlDomain

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 a standard control or a custom control.
	//
	// This member is required.
	ControlType types.ControlType

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListControlsOutput

type ListControlsOutput struct {

	// A list of metadata that the ListControls API returns for each control.
	ControlMetadataList []types.ControlMetadata

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

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

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 on a page or for an 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 that the keywords apply to.
	//
	// This member is required.
	Source types.SourceType

	// Represents the maximum number of results on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKeywordsForDataSourceOutput

type ListKeywordsForDataSourceOutput struct {

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

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

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

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 on a page or for an 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 on a page or for an API request call.
	MaxResults *int32

	// The pagination token that's used to fetch the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNotificationsOutput

type ListNotificationsOutput struct {

	// The pagination token that's 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
	// contains filtered or unexported fields
}

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 on a page or for an 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 resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

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

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

type Options

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

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

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

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

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

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

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

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

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

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

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.29.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RegisterAccountInput

type RegisterAccountInput struct {

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

	// The KMS key details.
	KmsKey *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type RegisterOrganizationAdminAccountInput

type RegisterOrganizationAdminAccountInput struct {

	// The identifier for the delegated administrator account.
	//
	// This member is required.
	AdminAccountId *string
	// contains filtered or unexported fields
}

type RegisterOrganizationAdminAccountOutput

type RegisterOrganizationAdminAccountOutput struct {

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

	// The identifier for the organization.
	OrganizationId *string

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartAssessmentFrameworkShareInput added in v1.11.0

type StartAssessmentFrameworkShareInput struct {

	// The Amazon Web Services account of the recipient.
	//
	// This member is required.
	DestinationAccount *string

	// The Amazon Web Services Region of the recipient.
	//
	// This member is required.
	DestinationRegion *string

	// The unique identifier for the custom framework to be shared.
	//
	// This member is required.
	FrameworkId *string

	// An optional comment from the sender about the share request.
	Comment *string
	// contains filtered or unexported fields
}

type StartAssessmentFrameworkShareOutput added in v1.11.0

type StartAssessmentFrameworkShareOutput struct {

	// The share request that's created by the StartAssessmentFrameworkShare API.
	AssessmentFrameworkShareRequest *types.AssessmentFrameworkShareRequest

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

type TagResourceInput

type TagResourceInput struct {

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

	// The tags that are associated with the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

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

type UntagResourceInput

type UntagResourceInput struct {

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

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

type UntagResourceOutput

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

type UpdateAssessmentControlInput

type UpdateAssessmentControlInput struct {

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

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

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

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

	// The status of the control.
	ControlStatus types.ControlStatus
	// contains filtered or unexported fields
}

type UpdateAssessmentControlOutput

type UpdateAssessmentControlOutput struct {

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

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

type UpdateAssessmentControlSetStatusInput

type UpdateAssessmentControlSetStatusInput struct {

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

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

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

	// The status of the control set that's being updated.
	//
	// This member is required.
	Status types.ControlSetStatus
	// contains filtered or unexported fields
}

type UpdateAssessmentControlSetStatusOutput

type UpdateAssessmentControlSetStatusOutput struct {

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

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

type UpdateAssessmentFrameworkInput

type UpdateAssessmentFrameworkInput struct {

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

	// The unique identifier for the 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 updated framework.
	Description *string
	// contains filtered or unexported fields
}

type UpdateAssessmentFrameworkOutput

type UpdateAssessmentFrameworkOutput struct {

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

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

type UpdateAssessmentFrameworkShareInput added in v1.11.0

type UpdateAssessmentFrameworkShareInput struct {

	// Specifies the update action for the share request.
	//
	// This member is required.
	Action types.ShareRequestAction

	// The unique identifier for the share request.
	//
	// This member is required.
	RequestId *string

	// Specifies whether the share request is a sent request or a received request.
	//
	// This member is required.
	RequestType types.ShareRequestType
	// contains filtered or unexported fields
}

type UpdateAssessmentFrameworkShareOutput added in v1.11.0

type UpdateAssessmentFrameworkShareOutput struct {

	// The updated share request that's returned by the UpdateAssessmentFrameworkShare
	// operation.
	AssessmentFrameworkShareRequest *types.AssessmentFrameworkShareRequest

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

type UpdateAssessmentInput

type UpdateAssessmentInput struct {

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

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

	// The description of the assessment.
	AssessmentDescription *string

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

	// The assessment report storage destination for the assessment that's being
	// updated.
	AssessmentReportsDestination *types.AssessmentReportsDestination

	// The list of roles for the assessment.
	Roles []types.Role
	// contains filtered or unexported fields
}

type UpdateAssessmentOutput

type UpdateAssessmentOutput struct {

	// The response object for the UpdateAssessment API. This is the name of the
	// updated assessment.
	Assessment *types.Assessment

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

type UpdateAssessmentStatusInput

type UpdateAssessmentStatusInput struct {

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

	// The current status of the assessment.
	//
	// This member is required.
	Status types.AssessmentStatus
	// contains filtered or unexported fields
}

type UpdateAssessmentStatusOutput

type UpdateAssessmentStatusOutput struct {

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

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

type UpdateControlInput

type UpdateControlInput struct {

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

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

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

	// The recommended actions to carry out if the control isn't 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 you should follow to determine if the control is met.
	TestingInformation *string
	// contains filtered or unexported fields
}

type UpdateControlOutput

type UpdateControlOutput struct {

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

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

type UpdateSettingsInput

type UpdateSettingsInput struct {

	// The default S3 destination bucket for storing assessment reports.
	DefaultAssessmentReportsDestination *types.AssessmentReportsDestination

	// The default S3 destination bucket for storing evidence finder exports.
	DefaultExportDestination *types.DefaultExportDestination

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

	// The deregistration policy for your Audit Manager data. You can use this
	// attribute to determine how your data is handled when you deregister Audit
	// Manager.
	DeregistrationPolicy *types.DeregistrationPolicy

	// Specifies whether the evidence finder feature is enabled. Change this attribute
	// to enable or disable evidence finder. When you use this attribute to disable
	// evidence finder, Audit Manager deletes the event data store that’s used to query
	// your evidence data. As a result, you can’t re-enable evidence finder and use the
	// feature again. Your only alternative is to deregister (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html)
	// and then re-register (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html)
	// Audit Manager.
	EvidenceFinderEnabled *bool

	// The KMS key details.
	KmsKey *string

	// The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager
	// sends notifications to.
	SnsTopic *string
	// contains filtered or unexported fields
}

type UpdateSettingsOutput

type UpdateSettingsOutput struct {

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

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

type ValidateAssessmentReportIntegrityInput

type ValidateAssessmentReportIntegrityInput struct {

	// The relative path of the Amazon S3 bucket that the assessment report is stored
	// in.
	//
	// This member is required.
	S3RelativePath *string
	// contains filtered or unexported fields
}

type ValidateAssessmentReportIntegrityOutput

type ValidateAssessmentReportIntegrityOutput struct {

	// The signature algorithm that's 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
	// contains filtered or unexported fields
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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