Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data StartAssessmentFrameworkShare = StartAssessmentFrameworkShare' {}
- newStartAssessmentFrameworkShare :: Text -> Text -> Text -> StartAssessmentFrameworkShare
- startAssessmentFrameworkShare_comment :: Lens' StartAssessmentFrameworkShare (Maybe Text)
- startAssessmentFrameworkShare_frameworkId :: Lens' StartAssessmentFrameworkShare Text
- startAssessmentFrameworkShare_destinationAccount :: Lens' StartAssessmentFrameworkShare Text
- startAssessmentFrameworkShare_destinationRegion :: Lens' StartAssessmentFrameworkShare Text
- data StartAssessmentFrameworkShareResponse = StartAssessmentFrameworkShareResponse' {}
- newStartAssessmentFrameworkShareResponse :: Int -> StartAssessmentFrameworkShareResponse
- startAssessmentFrameworkShareResponse_assessmentFrameworkShareRequest :: Lens' StartAssessmentFrameworkShareResponse (Maybe AssessmentFrameworkShareRequest)
- startAssessmentFrameworkShareResponse_httpStatus :: Lens' StartAssessmentFrameworkShareResponse Int
Creating a Request
data StartAssessmentFrameworkShare Source #
See: newStartAssessmentFrameworkShare
smart constructor.
Constructors
StartAssessmentFrameworkShare' | |
Fields
|
Instances
newStartAssessmentFrameworkShare Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> StartAssessmentFrameworkShare |
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.
startAssessmentFrameworkShare_destinationAccount :: Lens' StartAssessmentFrameworkShare Text Source #
The Amazon Web Services account of the recipient.
startAssessmentFrameworkShare_destinationRegion :: Lens' StartAssessmentFrameworkShare Text Source #
The Amazon Web Services Region of the recipient.
Destructuring the Response
data StartAssessmentFrameworkShareResponse Source #
See: newStartAssessmentFrameworkShareResponse
smart constructor.
Constructors
StartAssessmentFrameworkShareResponse' | |
Fields
|
Instances
newStartAssessmentFrameworkShareResponse Source #
Arguments
:: Int | |
-> StartAssessmentFrameworkShareResponse |
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
startAssessmentFrameworkShareResponse_assessmentFrameworkShareRequest :: Lens' StartAssessmentFrameworkShareResponse (Maybe AssessmentFrameworkShareRequest) Source #
The share request that's created by the StartAssessmentFrameworkShare
API.
startAssessmentFrameworkShareResponse_httpStatus :: Lens' StartAssessmentFrameworkShareResponse Int Source #
The response's http status code.