AccessGrant
Full AccessGrant structure returned by API operations.
Contents
- accountId
-
The AWS account ID that owns the grant.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]{12}Required: Yes
- createdAt
-
The timestamp when the grant was created.
Type: Timestamp
Required: Yes
- createdBy
-
The principal that created the grant.
Type: String
Required: Yes
- domainId
-
The ID of the domain the grant belongs to.
Type: String
Pattern:
d-[0-9a-z]{1,25}Required: Yes
- grantArn
-
The Amazon Resource Name (ARN) of the access grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:.+Required: Yes
- grantId
-
The unique ID of the access grant.
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
- grantType
-
Who manages the grant.
Type: String
Valid Values:
SERVICE_MANAGED | CUSTOMER_MANAGEDRequired: Yes
- permission
-
The permission granted.
Type: String
Valid Values:
SPACE_ADMIN | READ | READ_WRITE_DELETE | CUSTOMRequired: Yes
- principal
-
The principal receiving the grant.
Type: AccessGrantPrincipal object
Required: Yes
- spaceId
-
The space this grant applies to. Domain-scoped grants are returned by ListDomainAccessGrantsForOrganization instead.
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
- updatedAt
-
The timestamp when the grant was last updated.
Type: Timestamp
Required: Yes
- name
-
A name that identifies the access grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- scopedActions
-
Groups of actions allowed by the grant, each with the resource scopes and conditions that limit those actions.
Type: Array of ScopedActions objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: