Module: Aws::VerifiedPermissions::Types

Defined in:
gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb

Defined Under Namespace

Classes: AccessDeniedException, ActionIdentifier, AttributeValue, BatchIsAuthorizedInput, BatchIsAuthorizedInputItem, BatchIsAuthorizedOutput, BatchIsAuthorizedOutputItem, BatchIsAuthorizedWithTokenInput, BatchIsAuthorizedWithTokenInputItem, BatchIsAuthorizedWithTokenOutput, BatchIsAuthorizedWithTokenOutputItem, CognitoGroupConfiguration, CognitoGroupConfigurationDetail, CognitoGroupConfigurationItem, CognitoUserPoolConfiguration, CognitoUserPoolConfigurationDetail, CognitoUserPoolConfigurationItem, Configuration, ConfigurationDetail, ConfigurationItem, ConflictException, ContextDefinition, CreateIdentitySourceInput, CreateIdentitySourceOutput, CreatePolicyInput, CreatePolicyOutput, CreatePolicyStoreInput, CreatePolicyStoreOutput, CreatePolicyTemplateInput, CreatePolicyTemplateOutput, DeleteIdentitySourceInput, DeleteIdentitySourceOutput, DeletePolicyInput, DeletePolicyOutput, DeletePolicyStoreInput, DeletePolicyStoreOutput, DeletePolicyTemplateInput, DeletePolicyTemplateOutput, DeterminingPolicyItem, EntitiesDefinition, EntityIdentifier, EntityItem, EntityReference, EvaluationErrorItem, GetIdentitySourceInput, GetIdentitySourceOutput, GetPolicyInput, GetPolicyOutput, GetPolicyStoreInput, GetPolicyStoreOutput, GetPolicyTemplateInput, GetPolicyTemplateOutput, GetSchemaInput, GetSchemaOutput, IdentitySourceDetails, IdentitySourceFilter, IdentitySourceItem, IdentitySourceItemDetails, InternalServerException, IsAuthorizedInput, IsAuthorizedOutput, IsAuthorizedWithTokenInput, IsAuthorizedWithTokenOutput, ListIdentitySourcesInput, ListIdentitySourcesOutput, ListPoliciesInput, ListPoliciesOutput, ListPolicyStoresInput, ListPolicyStoresOutput, ListPolicyTemplatesInput, ListPolicyTemplatesOutput, PolicyDefinition, PolicyDefinitionDetail, PolicyDefinitionItem, PolicyFilter, PolicyItem, PolicyStoreItem, PolicyTemplateItem, PutSchemaInput, PutSchemaOutput, ResourceConflict, ResourceNotFoundException, SchemaDefinition, ServiceQuotaExceededException, StaticPolicyDefinition, StaticPolicyDefinitionDetail, StaticPolicyDefinitionItem, TemplateLinkedPolicyDefinition, TemplateLinkedPolicyDefinitionDetail, TemplateLinkedPolicyDefinitionItem, ThrottlingException, UpdateCognitoGroupConfiguration, UpdateCognitoUserPoolConfiguration, UpdateConfiguration, UpdateIdentitySourceInput, UpdateIdentitySourceOutput, UpdatePolicyDefinition, UpdatePolicyInput, UpdatePolicyOutput, UpdatePolicyStoreInput, UpdatePolicyStoreOutput, UpdatePolicyTemplateInput, UpdatePolicyTemplateOutput, UpdateStaticPolicyDefinition, ValidationException, ValidationExceptionField, ValidationSettings

Instance Attribute Summary collapse

Instance Attribute Details

#boolean ⇒ Boolean

An attribute value of Boolean type.

Example: \{"boolean": true\}

Returns:

  • (Boolean) 


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 142

class AttributeValue < Struct.new(
  :boolean,
  :entity_identifier,
  :long,
  :string,
  :set,
  :record,
  :unknown)
  SENSITIVE = [:boolean, :long, :string]
  include Aws::Structure
  include Aws::Structure::Union

  class Boolean < AttributeValue; end
  class EntityIdentifier < AttributeValue; end
  class Long < AttributeValue; end
  class String < AttributeValue; end
  class Set < AttributeValue; end
  class Record < AttributeValue; end
  class Unknown < AttributeValue; end
end

#cedar_json ⇒ String

A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

Returns:

  • (String) 


2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 2870

class SchemaDefinition < Struct.new(
  :cedar_json,
  :unknown)
  SENSITIVE = [:cedar_json]
  include Aws::Structure
  include Aws::Structure::Union

  class CedarJson < SchemaDefinition; end
  class Unknown < SchemaDefinition; end
end

#cognito_user_pool_configuration ⇒ Types::UpdateCognitoUserPoolConfiguration

Contains configuration details of a Amazon Cognito user pool.

Returns:



707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 707

class Configuration < Struct.new(
  :cognito_user_pool_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CognitoUserPoolConfiguration < Configuration; end
  class Unknown < Configuration; end
end

#context_map ⇒ Hash<String,Types::AttributeValue>

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

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

Returns:



851
852
853
854
855
856
857
858
859
860
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 851

class ContextDefinition < Struct.new(
  :context_map,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ContextMap < ContextDefinition; end
  class Unknown < ContextDefinition; end
end

#entity_identifier ⇒ Types::EntityIdentifier

An attribute value of type EntityIdentifier.

Example: "entityIdentifier": \{ "entityId": "<id>", "entityType": "<entity type>"\}

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 142

class AttributeValue < Struct.new(
  :boolean,
  :entity_identifier,
  :long,
  :string,
  :set,
  :record,
  :unknown)
  SENSITIVE = [:boolean, :long, :string]
  include Aws::Structure
  include Aws::Structure::Union

  class Boolean < AttributeValue; end
  class EntityIdentifier < AttributeValue; end
  class Long < AttributeValue; end
  class String < AttributeValue; end
  class Set < AttributeValue; end
  class Record < AttributeValue; end
  class Unknown < AttributeValue; end
end

#entity_list ⇒ Array<Types::EntityItem>

An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

Returns:



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1363

class EntitiesDefinition < Struct.new(
  :entity_list,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EntityList < EntitiesDefinition; end
  class Unknown < EntitiesDefinition; end
end

#identifier ⇒ Types::EntityIdentifier

The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

Returns:



1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1472

class EntityReference < Struct.new(
  :unspecified,
  :identifier,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Unspecified < EntityReference; end
  class Identifier < EntityReference; end
  class Unknown < EntityReference; end
end

#long ⇒ Integer

An attribute value of Long type.

Example: \{"long": 0\}

Returns:

  • (Integer) 


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 142

class AttributeValue < Struct.new(
  :boolean,
  :entity_identifier,
  :long,
  :string,
  :set,
  :record,
  :unknown)
  SENSITIVE = [:boolean, :long, :string]
  include Aws::Structure
  include Aws::Structure::Union

  class Boolean < AttributeValue; end
  class EntityIdentifier < AttributeValue; end
  class Long < AttributeValue; end
  class String < AttributeValue; end
  class Set < AttributeValue; end
  class Record < AttributeValue; end
  class Unknown < AttributeValue; end
end

#record ⇒ Hash<String,Types::AttributeValue>

An attribute value of Record type.

Example: \{"record": \{ "keyName": \{\} \} \}

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 142

class AttributeValue < Struct.new(
  :boolean,
  :entity_identifier,
  :long,
  :string,
  :set,
  :record,
  :unknown)
  SENSITIVE = [:boolean, :long, :string]
  include Aws::Structure
  include Aws::Structure::Union

  class Boolean < AttributeValue; end
  class EntityIdentifier < AttributeValue; end
  class Long < AttributeValue; end
  class String < AttributeValue; end
  class Set < AttributeValue; end
  class Record < AttributeValue; end
  class Unknown < AttributeValue; end
end

#set ⇒ Array<Types::AttributeValue>

An attribute value of Set type.

Example: \{"set": [ \{\} ] \}

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 142

class AttributeValue < Struct.new(
  :boolean,
  :entity_identifier,
  :long,
  :string,
  :set,
  :record,
  :unknown)
  SENSITIVE = [:boolean, :long, :string]
  include Aws::Structure
  include Aws::Structure::Union

  class Boolean < AttributeValue; end
  class EntityIdentifier < AttributeValue; end
  class Long < AttributeValue; end
  class String < AttributeValue; end
  class Set < AttributeValue; end
  class Record < AttributeValue; end
  class Unknown < AttributeValue; end
end

#static ⇒ Types::UpdateStaticPolicyDefinition

Contains details about the updates to be applied to a static policy.

Returns:



2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 2473

class PolicyDefinition < Struct.new(
  :static,
  :template_linked,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Static < PolicyDefinition; end
  class TemplateLinked < PolicyDefinition; end
  class Unknown < PolicyDefinition; end
end

#string ⇒ String

An attribute value of String type.

Example: \{"string": "abc"\}

Returns:

  • (String) 


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 142

class AttributeValue < Struct.new(
  :boolean,
  :entity_identifier,
  :long,
  :string,
  :set,
  :record,
  :unknown)
  SENSITIVE = [:boolean, :long, :string]
  include Aws::Structure
  include Aws::Structure::Union

  class Boolean < AttributeValue; end
  class EntityIdentifier < AttributeValue; end
  class Long < AttributeValue; end
  class String < AttributeValue; end
  class Set < AttributeValue; end
  class Record < AttributeValue; end
  class Unknown < AttributeValue; end
end

#template_linked ⇒ Types::TemplateLinkedPolicyDefinitionItem

Information about a template-linked policy that was created by instantiating a policy template.

Returns:



2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 2473

class PolicyDefinition < Struct.new(
  :static,
  :template_linked,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Static < PolicyDefinition; end
  class TemplateLinked < PolicyDefinition; end
  class Unknown < PolicyDefinition; end
end

#unspecified ⇒ Boolean

Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

Returns:

  • (Boolean) 


1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1472

class EntityReference < Struct.new(
  :unspecified,
  :identifier,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Unspecified < EntityReference; end
  class Identifier < EntityReference; end
  class Unknown < EntityReference; end
end