amazonka-auditmanager-2.0: Amazon Audit Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AuditManager.StartAssessmentFrameworkShare

Description

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, 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 in the Audit Manager User Guide.

Synopsis

Creating a Request

data StartAssessmentFrameworkShare Source #

See: newStartAssessmentFrameworkShare smart constructor.

Constructors

StartAssessmentFrameworkShare' 

Fields

Instances

Instances details
ToJSON StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

ToHeaders StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

ToPath StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

ToQuery StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

AWSRequest StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Generic StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Associated Types

type Rep StartAssessmentFrameworkShare :: Type -> Type #

Read StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Show StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

NFData StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Eq StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Hashable StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

type AWSResponse StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

type Rep StartAssessmentFrameworkShare Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

type Rep StartAssessmentFrameworkShare = D1 ('MetaData "StartAssessmentFrameworkShare" "Amazonka.AuditManager.StartAssessmentFrameworkShare" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "StartAssessmentFrameworkShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "frameworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "destinationAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartAssessmentFrameworkShare Source #

Create a value of StartAssessmentFrameworkShare with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartAssessmentFrameworkShare, startAssessmentFrameworkShare_comment - An optional comment from the sender about the share request.

StartAssessmentFrameworkShare, startAssessmentFrameworkShare_frameworkId - The unique identifier for the custom framework to be shared.

StartAssessmentFrameworkShare, startAssessmentFrameworkShare_destinationAccount - The Amazon Web Services account of the recipient.

StartAssessmentFrameworkShare, startAssessmentFrameworkShare_destinationRegion - The Amazon Web Services Region of the recipient.

Request Lenses

startAssessmentFrameworkShare_comment :: Lens' StartAssessmentFrameworkShare (Maybe Text) Source #

An optional comment from the sender about the share request.

startAssessmentFrameworkShare_frameworkId :: Lens' StartAssessmentFrameworkShare Text Source #

The unique identifier for the custom framework to be shared.

Destructuring the Response

data StartAssessmentFrameworkShareResponse Source #

Constructors

StartAssessmentFrameworkShareResponse' 

Fields

Instances

Instances details
Generic StartAssessmentFrameworkShareResponse Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Read StartAssessmentFrameworkShareResponse Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Show StartAssessmentFrameworkShareResponse Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

NFData StartAssessmentFrameworkShareResponse Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

Eq StartAssessmentFrameworkShareResponse Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

type Rep StartAssessmentFrameworkShareResponse Source # 
Instance details

Defined in Amazonka.AuditManager.StartAssessmentFrameworkShare

type Rep StartAssessmentFrameworkShareResponse = D1 ('MetaData "StartAssessmentFrameworkShareResponse" "Amazonka.AuditManager.StartAssessmentFrameworkShare" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "StartAssessmentFrameworkShareResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assessmentFrameworkShareRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssessmentFrameworkShareRequest)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartAssessmentFrameworkShareResponse Source #

Create a value of StartAssessmentFrameworkShareResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:assessmentFrameworkShareRequest:StartAssessmentFrameworkShareResponse', startAssessmentFrameworkShareResponse_assessmentFrameworkShareRequest - The share request that's created by the StartAssessmentFrameworkShare API.

$sel:httpStatus:StartAssessmentFrameworkShareResponse', startAssessmentFrameworkShareResponse_httpStatus - The response's http status code.

Response Lenses