Request Parameters Response Elements Errors Examples See Also

ListAccessProfiles

Returns the access profiles in a space.

Request Parameters

maxResults

The maximum number of access profiles to return per page. Defaults to 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

A token to retrieve the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

spaceId

The unique ID of the space.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Elements

The following elements are returned by the service.

items

The list of access profile summaries.

Type: Array of AccessProfileSummary objects

nextToken

A token to retrieve the next page of results, or null if there are no more results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The caller is not authorized to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

errorCode: The error code associated with the internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

errorCode: The error code associated with the failure.
resourceId: The identifier of the resource that could not be found. Not always present.
resourceType: The type of the resource that could not be found. Not always present.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to exceeding the allowed request rate.

retryAfterSeconds: The number of seconds to wait before retrying the request. Not always present.

HTTP Status Code: 429

ValidationException

A parameter is specified incorrectly.

errorCode: The error code associated with the validation failure.

HTTP Status Code: 400

Examples

List access profiles in a space

The following example lists the first page of access profiles in a space and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request


{
  "maxResults": 50,
  "spaceId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d"
}

Sample Response


{
  "items": [
    {
      "arn": "arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly",
      "description": "Read-only access for analysts.",
      "name": "Analyst read-only profile",
      "profileId": "analyst-readonly",
      "profileType": "CUSTOMER_MANAGED"
    },
    {
      "arn": "arn:aws:cloudwatch:us-east-1:123456789012:access-profile/oncall-admin",
      "description": "Full access for on-call responders.",
      "name": "On-call admin profile",
      "profileId": "oncall-admin",
      "profileType": "CUSTOMER_MANAGED"
    }
  ],
  "nextToken": "eyJvZmZzZXQiOjIwfQ=="
}