[ aws . ds ]

describe-shared-directories

Description

Returns the shared directories in your account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-shared-directories is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: SharedDirectories

Synopsis

  describe-shared-directories
--owner-directory-id <value>
[--shared-directory-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--owner-directory-id (string)

Returns the identifier of the directory in the directory owner account.

--shared-directory-ids (list)

A list of identifiers of all shared directories in your account.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

SharedDirectories -> (list)

A list of all shared directories in your account.

(structure)

Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.

OwnerAccountId -> (string)

Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.

OwnerDirectoryId -> (string)

Identifier of the directory in the directory owner account.

ShareMethod -> (string)

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS ) or with any AWS account by sending a shared directory request (HANDSHAKE ).

SharedAccountId -> (string)

Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId ) in the directory owner account.

SharedDirectoryId -> (string)

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

ShareStatus -> (string)

Current directory status of the shared AWS Managed Microsoft AD directory.

ShareNotes -> (string)

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.

CreatedDateTime -> (timestamp)

The date and time that the shared directory was created.

LastUpdatedDateTime -> (timestamp)

The date and time that the shared directory was last updated.

NextToken -> (string)

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.