[ aws . iotsitewise ]

list-access-policies

Description

Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or project).

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-access-policies 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: accessPolicySummaries

Synopsis

  list-access-policies
[--identity-type <value>]
[--identity-id <value>]
[--resource-type <value>]
[--resource-id <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

--identity-type (string)

The type of identity (user or group). This parameter is required if you specify identityId .

Possible values:

• USER

• GROUP

--identity-id (string)

The ID of the identity. This parameter is required if you specify identityType .

--resource-type (string)

The type of resource (portal or project). This parameter is required if you specify resourceId .

Possible values:

• PORTAL

• PROJECT

--resource-id (string)

The ID of the resource. This parameter is required if you specify resourceType .

--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.

Examples

To list all access policies

The following list-access-policies example lists all access policies for a user who is a portal administrator.

aws iotsitewise list-access-policies \
    --identity-type USER \
    --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE

Output:

{
    "accessPolicySummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
            "identity": {
                "user": {
                    "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
                }
            },
            "resource": {
                "portal": {
                    "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
                }
            },
            "permission": "ADMINISTRATOR"
        }
    ]
}

For more information, see Administering your portals in the AWS IoT SiteWise User Guide.

Output

accessPolicySummaries -> (list)

A list that summarizes each access policy.

(structure)

Contains an access policy that defines an AWS SSO identity’s access to an AWS IoT SiteWise Monitor resource.

id -> (string)

The ID of the access policy.

identity -> (structure)

The AWS SSO identity (a user or group).

user -> (structure)

A user identity.

id -> (string)

The AWS SSO ID of the user.

group -> (structure)

A group identity.

id -> (string)

The AWS SSO ID of the group.

resource -> (structure)

The AWS IoT SiteWise Monitor resource (a portal or project).

portal -> (structure)

A portal resource.

id -> (string)

The ID of the portal.

project -> (structure)

A project resource.

id -> (string)

The ID of the project.

permission -> (string)

The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.

creationDate -> (timestamp)

The date the access policy was created, in Unix epoch time.

lastUpdateDate -> (timestamp)

The date the access policy was last updated, in Unix epoch time.

nextToken -> (string)

The token for the next set of results, or null if there are no additional results.