Package software.amazon.awssdk.services.verifiedpermissions.model

Class GetPolicyResponse

    • Method Detail

      • policyStoreId

        public final String policyStoreId()

        The ID of the policy store that contains the policy that you want information about.

        Returns:
        The ID of the policy store that contains the policy that you want information about.

      • policyId

        public final String policyId()

        The unique ID of the policy that you want information about.

        Returns:
        The unique ID of the policy that you want information about.

      • policyTypeAsString

        public final String policyTypeAsString()

        The type of the policy.

        If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

        Returns:
        The type of the policy.
        See Also:
        PolicyType

      • principal

        public final EntityIdentifier principal()

        The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

        Returns:
        The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

      • resource

        public final EntityIdentifier resource()

        The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

        Returns:
        The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

      • hasActions

        public final boolean hasActions()
        For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • actions

        public final List<ActionIdentifier> actions()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

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

      • definition

        public final PolicyDefinitionDetail definition()

        The definition of the requested policy.

        Returns:
        The definition of the requested policy.

      • createdDate

        public final Instant createdDate()

        The date and time that the policy was originally created.

        Returns:
        The date and time that the policy was originally created.

      • lastUpdatedDate

        public final Instant lastUpdatedDate()

        The date and time that the policy was last updated.

        Returns:
        The date and time that the policy was last updated.

      • effect

        public final PolicyEffect effect()

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

        If the service returns an enum value that is not available in the current SDK version, effect will return PolicyEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().

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

      • effectAsString

        public final String effectAsString()

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

        If the service returns an enum value that is not available in the current SDK version, effect will return PolicyEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object