| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DirectoryService.ShareDirectory
Description
Shares a specified directory (DirectoryId) in your Amazon Web Services
account (directory owner) with another Amazon Web Services account
(directory consumer). With this operation you can use your directory
from any Amazon Web Services account and from any Amazon VPC within an
Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory
can be shared between Amazon Web Services accounts inside the same
Amazon Web Services organization (ORGANIZATIONS). It also determines
whether you can share the directory with any other Amazon Web Services
account either inside or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called,
which sends a directory sharing request to the directory consumer.
Synopsis
- data ShareDirectory = ShareDirectory' {}
- newShareDirectory :: Text -> ShareTarget -> ShareMethod -> ShareDirectory
- shareDirectory_shareNotes :: Lens' ShareDirectory (Maybe Text)
- shareDirectory_directoryId :: Lens' ShareDirectory Text
- shareDirectory_shareTarget :: Lens' ShareDirectory ShareTarget
- shareDirectory_shareMethod :: Lens' ShareDirectory ShareMethod
- data ShareDirectoryResponse = ShareDirectoryResponse' {}
- newShareDirectoryResponse :: Int -> ShareDirectoryResponse
- shareDirectoryResponse_sharedDirectoryId :: Lens' ShareDirectoryResponse (Maybe Text)
- shareDirectoryResponse_httpStatus :: Lens' ShareDirectoryResponse Int
Creating a Request
data ShareDirectory Source #
See: newShareDirectory smart constructor.
Constructors
| ShareDirectory' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ShareTarget | |
| -> ShareMethod | |
| -> ShareDirectory |
Create a value of ShareDirectory 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:shareNotes:ShareDirectory', shareDirectory_shareNotes - A directory share request that is sent by the directory owner to the
directory consumer. The request includes a typed message to help the
directory consumer administrator determine whether to approve or reject
the share invitation.
$sel:directoryId:ShareDirectory', shareDirectory_directoryId - Identifier of the Managed Microsoft AD directory that you want to share
with other Amazon Web Services accounts.
$sel:shareTarget:ShareDirectory', shareDirectory_shareTarget - Identifier for the directory consumer account with whom the directory is
to be shared.
$sel:shareMethod:ShareDirectory', shareDirectory_shareMethod - The method used when sharing a directory to determine whether the
directory should be shared within your Amazon Web Services organization
(ORGANIZATIONS) or with any Amazon Web Services account by sending a
directory sharing request (HANDSHAKE).
Request Lenses
shareDirectory_shareNotes :: Lens' ShareDirectory (Maybe Text) Source #
A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
shareDirectory_directoryId :: Lens' ShareDirectory Text Source #
Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.
shareDirectory_shareTarget :: Lens' ShareDirectory ShareTarget Source #
Identifier for the directory consumer account with whom the directory is to be shared.
shareDirectory_shareMethod :: Lens' ShareDirectory ShareMethod Source #
The method used when sharing a directory to determine whether the
directory should be shared within your Amazon Web Services organization
(ORGANIZATIONS) or with any Amazon Web Services account by sending a
directory sharing request (HANDSHAKE).
Destructuring the Response
data ShareDirectoryResponse Source #
See: newShareDirectoryResponse smart constructor.
Constructors
| ShareDirectoryResponse' | |
Fields
| |
Instances
newShareDirectoryResponse Source #
Create a value of ShareDirectoryResponse 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:sharedDirectoryId:ShareDirectoryResponse', shareDirectoryResponse_sharedDirectoryId - Identifier of the directory that is stored in the directory consumer
account that is shared from the specified directory (DirectoryId).
$sel:httpStatus:ShareDirectoryResponse', shareDirectoryResponse_httpStatus - The response's http status code.
Response Lenses
shareDirectoryResponse_sharedDirectoryId :: Lens' ShareDirectoryResponse (Maybe Text) Source #
Identifier of the directory that is stored in the directory consumer
account that is shared from the specified directory (DirectoryId).
shareDirectoryResponse_httpStatus :: Lens' ShareDirectoryResponse Int Source #
The response's http status code.