AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . auditmanager ]

list-assessment-framework-share-requests

Description

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

See also: AWS API Documentation

Synopsis

  list-assessment-framework-share-requests
--request-type <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--request-type (string)

Specifies whether the share request is a sent request or a received request.

Possible values:

  • SENT
  • RECEIVED

--next-token (string)

The pagination token that's used to fetch the next set of results.

--max-results (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

assessmentFrameworkShareRequests -> (list)

The list of share requests that the ListAssessmentFrameworkShareRequests API returned.

(structure)

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

id -> (string)

The unique identifier for the share request.

frameworkId -> (string)

The unique identifier for the shared custom framework.

frameworkName -> (string)

The name of the custom framework that the share request is for.

frameworkDescription -> (string)

The description of the shared custom framework.

status -> (string)

The status of the share request.

sourceAccount -> (string)

The Amazon Web Services account of the sender.

destinationAccount -> (string)

The Amazon Web Services account of the recipient.

destinationRegion -> (string)

The Amazon Web Services Region of the recipient.

expirationTime -> (timestamp)

The time when the share request expires.

creationTime -> (timestamp)

The time when the share request was created.

lastUpdated -> (timestamp)

Specifies when the share request was last updated.

comment -> (string)

An optional comment from the sender about the share request.

standardControlsCount -> (integer)

The number of standard controls that are part of the shared custom framework.

customControlsCount -> (integer)

The number of custom controls that are part of the shared custom framework.

complianceType -> (string)

The compliance type that the shared custom framework supports, such as CIS or HIPAA.

nextToken -> (string)

The pagination token that's used to fetch the next set of results.