aws_sdk_verifiedpermissions

Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

  • builders
    Builders
  • error
    Error types that Amazon Verified Permissions can respond with.

Structs§

Enums§

  • AttributeValue

    The value of an attribute.

    Contains information about the runtime context for a request for which an authorization decision is made.

    This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

  • BatchGetPolicyErrorCode
    When writing a match expression against BatchGetPolicyErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • Configuration

    Contains configuration information used when creating a new identity source.

    This data type is used as a request parameter for the CreateIdentitySource operation.

  • ConfigurationDetail

    Contains configuration information about an identity source.

    This data type is a response parameter to the GetIdentitySource operation.

  • ConfigurationItem

    Contains configuration information about an identity source.

    This data type is a response parameter to the ListIdentitySources operation.

  • ContextDefinition

    Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

    This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

    Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

  • Decision
    When writing a match expression against Decision, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • EntitiesDefinition

    Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.

    This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.

  • EntityReference

    Contains information about a principal or resource that can be referenced in a Cedar policy.

    This data type is used as part of the PolicyFilter structure that is used as a request parameter for the ListPolicies operation..

  • OpenIdConnectTokenSelection

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.

  • OpenIdConnectTokenSelectionDetail

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.

  • OpenIdConnectTokenSelectionItem

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySources.

  • OpenIdIssuer
    When writing a match expression against OpenIdIssuer, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • PolicyDefinition

    A structure that contains the details for a Cedar policy definition. It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

    This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an static or a templateLinked element.

  • PolicyDefinitionDetail

    A structure that describes a policy definition. It must always have either an static or a templateLinked element.

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

  • PolicyDefinitionItem

    A structure that describes a PolicyDefinintion. It will always have either an StaticPolicy or a TemplateLinkedPolicy element.

    This data type is used as a response parameter for the CreatePolicy and ListPolicies operations.

  • PolicyEffect
    When writing a match expression against PolicyEffect, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • PolicyType
    When writing a match expression against PolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • ResourceType
    When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • SchemaDefinition

    Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to STRICT, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.

  • UpdateConfiguration

    Contains an update to replace the configuration in an existing identity source.

  • UpdateOpenIdConnectTokenSelection

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.

  • UpdatePolicyDefinition

    Contains information about updates to be applied to a policy.

    This data type is used as a request parameter in the UpdatePolicy operation.

  • ValidationMode
    When writing a match expression against ValidationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.