Gets a list of report groups that are shared with other AWS accounts or users.
Request Syntax
{
"maxResults": number,
"nextToken": "string",
"sortBy": "string",
"sortOrder": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
-
The maximum number of paginated shared report groups per response. Use
nextTokento iterate pages in the list of returnedReportGroupobjects. The default value is 100.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
-
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.Type: String
Required: No
-
The criterion to be used to list report groups shared with the current AWS account or user. Valid values include:
-
ARN: List based on the ARN. -
MODIFIED_TIME: List based on when information about the shared report group was last changed.
Type: String
Valid Values:
ARN | MODIFIED_TIMERequired: No
-
-
The order in which to list shared report groups. Valid values include:
-
ASCENDING: List in ascending order. -
DESCENDING: List in descending order.
Type: String
Valid Values:
ASCENDING | DESCENDINGRequired: No
-
Response Syntax
{
"nextToken": "string",
"reportGroups": [ "string" ]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
-
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.Type: String
-
The list of ARNs for the report groups shared with the current AWS account or user.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInputException
-
The input value that was provided is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
