PolicyItem - Amazon Verified Permissions

PolicyItem

Contains information about a policy.

This data type is used as a response parameter for the ListPolicies operation.

Contents

Note

In the following list, the required parameters are described first.

createdDate

The date and time the policy was created.

Type: Timestamp

Required: Yes

definition

The policy definition of an item in the list of policies returned.

Type: PolicyDefinitionItem object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

lastUpdatedDate

The date and time the policy was most recently updated.

Type: Timestamp

Required: Yes

policyId

The identifier of the policy you want information about.

Type: String

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

Pattern: [a-zA-Z0-9-]*

Required: Yes

policyStoreId

The identifier of the policy store where the policy you want information about is stored.

Type: String

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

Pattern: [a-zA-Z0-9-]*

Required: Yes

policyType

The type of the policy. This is one of the following values:

  • STATIC

  • TEMPLATE_LINKED

Type: String

Valid Values: STATIC | TEMPLATE_LINKED

Required: Yes

actions

The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

Type: Array of ActionIdentifier objects

Required: No

effect

The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

Type: String

Valid Values: Permit | Forbid

Required: No

principal

The principal associated with the policy.

Type: EntityIdentifier object

Required: No

resource

The resource associated with the policy.

Type: EntityIdentifier object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: