aws-sdk-verifiedpermissions 1.36.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b664d45dcb19df6e5952721c0eef972343730766b80ff837f5e1ba1a78924f0f
-  data.tar.gz: 5ac7f85cd2204a6d4d9dfaada5b17404491893b24eb2c266159e6490f63dc88e
+  metadata.gz: d08a306115a1686645ad54457fc1e969b50aebb602f8dbe28bd057862f68d3a4
+  data.tar.gz: c4b8c00be8ea3c6544a183ab5c7d56589b38d0829b7bf6b1c7503da5cefd9198
 SHA512:
-  metadata.gz: 5d9502fae306a58a655cf657b39916010b7a2767f2afb92c1ae2039e2fff1ac859e215aec356fb0be93b8bc5325a92f01b0dfa291dae9d7f0804b17d24ead786
-  data.tar.gz: 76d1c28ba3a006705a9b2d1dfd7f51ef7bd0affd8a9819822b08bf0986fecd9e7514b45453debb371ae42e8948b0d209caa40cebe79982f197f81534bff2117a
+  metadata.gz: 30afc8bc4b5af061b02c6aca31134fca5a08ac00b7094b48cf8aa194743aa4576e7f3a8064abd64ea13141a129a2c1e345e449b2d183d02f97f1658209a7f4c5
+  data.tar.gz: 982c6219f7c8a8c85b8a473de95e2a35c2cc831b83b22c212f319af0bd9aaacd1e308916e033619c08902afe79f9f70507c843aea42122a3dda1fb8465d1d13e

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.37.0 (2024-11-06)
+------------------
+
+* Feature - Adding BatchGetPolicy API which supports the retrieval of multiple policies across multiple policy stores within a single request.
+
 1.36.0 (2024-10-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.36.0
+1.37.0

data/lib/aws-sdk-verifiedpermissions/client.rb

@@ -454,6 +454,135 @@ module Aws::VerifiedPermissions
 
     # @!group API Operations
 
+    # Retrieves information about a group (batch) of policies.
+    #
+    # <note markdown="1"> The `BatchGetPolicy` operation doesn't have its own IAM permission.
+    # To authorize this operation for Amazon Web Services principals,
+    # include the permission `verifiedpermissions:GetPolicy` in their IAM
+    # policies.
+    #
+    #  </note>
+    #
+    # @option params [required, Array<Types::BatchGetPolicyInputItem>] :requests
+    #   An array of up to 100 policies you want information about.
+    #
+    # @return [Types::BatchGetPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetPolicyOutput#results #results} => Array&lt;Types::BatchGetPolicyOutputItem&gt;
+    #   * {Types::BatchGetPolicyOutput#errors #errors} => Array&lt;Types::BatchGetPolicyErrorItem&gt;
+    #
+    #
+    # @example Example: To retrieve details about a policy
+    #
+    #   # The following example retrieves information about the specified policy contained in the specified policy store. In this
+    #   # example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific
+    #   # principal and resource used by this policy.
+    #
+    #   resp = client.batch_get_policy({
+    #     requests: [
+    #       {
+    #         policy_id: "PWv5M6d5HePx3gVVLKY1nK", 
+    #         policy_store_id: "ERZeDpRc34dkYZeb6FZRVC", 
+    #       }, 
+    #       {
+    #         policy_id: "LzFn6KgLWvv4Mbegus35jn", 
+    #         policy_store_id: "ERZeDpRc34dkYZeb6FZRVC", 
+    #       }, 
+    #       {
+    #         policy_id: "77gLjer8H5o3mvrnMGrSL5", 
+    #         policy_store_id: "ERZeDpRc34dkYZeb6FZRVC", 
+    #       }, 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     errors: [
+    #     ], 
+    #     results: [
+    #       {
+    #         created_date: Time.parse("2024-10-18T18:53:39.258153Z"), 
+    #         definition: {
+    #           static: {
+    #             description: "Users can manage account resources in any account they own", 
+    #             statement: "permit (principal, action in PhotoFlash::Action::\"ManageAccount\",resource) when { resource in principal.Account };", 
+    #           }, 
+    #         }, 
+    #         last_updated_date: Time.parse("2024-10-18T18:53:39.258153Z"), 
+    #         policy_id: "PWv5M6d5HePx3gVVLKY1nK", 
+    #         policy_store_id: "ERZeDpRc34dkYZeb6FZRVC", 
+    #         policy_type: "STATIC", 
+    #       }, 
+    #       {
+    #         created_date: Time.parse("2024-10-18T18:57:03.305027Z"), 
+    #         definition: {
+    #           static: {
+    #             description: "User alice can't delete any photos.", 
+    #             statement: "forbid (principal == PhotoFlash::User::\"alice\", action in [PhotoFlash::Action::\"DeletePhoto\"], resource);", 
+    #           }, 
+    #         }, 
+    #         last_updated_date: Time.parse("2024-10-18T18:57:03.305027Z"), 
+    #         policy_id: "LzFn6KgLWvv4Mbegus35jn", 
+    #         policy_store_id: "ERZeDpRc34dkYZeb6FZRVC", 
+    #         policy_type: "STATIC", 
+    #       }, 
+    #       {
+    #         created_date: Time.parse("2024-10-18T18:57:48.005343Z"), 
+    #         definition: {
+    #           static: {
+    #             description: "User alice can view and delete photos.", 
+    #             statement: "permit (principal == PhotoFlash::User::\"alice\", action in [PhotoFlash::Action::\"DeletePhoto\", PhotoFlash::Action::\"ViewPhoto\"], resource);", 
+    #           }, 
+    #         }, 
+    #         last_updated_date: Time.parse("2024-10-18T18:57:48.005343Z"), 
+    #         policy_id: "77gLjer8H5o3mvrnMGrSL5", 
+    #         policy_store_id: "ERZeDpRc34dkYZeb6FZRVC", 
+    #         policy_type: "STATIC", 
+    #       }, 
+    #     ], 
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_policy({
+    #     requests: [ # required
+    #       {
+    #         policy_store_id: "PolicyStoreId", # required
+    #         policy_id: "PolicyId", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.results #=> Array
+    #   resp.results[0].policy_store_id #=> String
+    #   resp.results[0].policy_id #=> String
+    #   resp.results[0].policy_type #=> String, one of "STATIC", "TEMPLATE_LINKED"
+    #   resp.results[0].definition.static.description #=> String
+    #   resp.results[0].definition.static.statement #=> String
+    #   resp.results[0].definition.template_linked.policy_template_id #=> String
+    #   resp.results[0].definition.template_linked.principal.entity_type #=> String
+    #   resp.results[0].definition.template_linked.principal.entity_id #=> String
+    #   resp.results[0].definition.template_linked.resource.entity_type #=> String
+    #   resp.results[0].definition.template_linked.resource.entity_id #=> String
+    #   resp.results[0].created_date #=> Time
+    #   resp.results[0].last_updated_date #=> Time
+    #   resp.errors #=> Array
+    #   resp.errors[0].code #=> String, one of "POLICY_STORE_NOT_FOUND", "POLICY_NOT_FOUND"
+    #   resp.errors[0].policy_store_id #=> String
+    #   resp.errors[0].policy_id #=> String
+    #   resp.errors[0].message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchGetPolicy AWS API Documentation
+    #
+    # @overload batch_get_policy(params = {})
+    # @param [Hash] params ({})
+    def batch_get_policy(params = {}, options = {})
+      req = build_request(:batch_get_policy, params)
+      req.send_request(options)
+    end
+
     # Makes a series of decisions about multiple authorization requests for
     # one principal or resource. Each request contains the equivalent
     # content of an `IsAuthorized` request: principal, action, resource, and
@@ -3644,7 +3773,7 @@ module Aws::VerifiedPermissions
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-verifiedpermissions'
-      context[:gem_version] = '1.36.0'
+      context[:gem_version] = '1.37.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-verifiedpermissions/client_api.rb

@@ -22,6 +22,15 @@ module Aws::VerifiedPermissions
     AttributeValue = Shapes::UnionShape.new(name: 'AttributeValue')
     Audience = Shapes::StringShape.new(name: 'Audience')
     Audiences = Shapes::ListShape.new(name: 'Audiences')
+    BatchGetPolicyErrorCode = Shapes::StringShape.new(name: 'BatchGetPolicyErrorCode')
+    BatchGetPolicyErrorItem = Shapes::StructureShape.new(name: 'BatchGetPolicyErrorItem')
+    BatchGetPolicyErrorList = Shapes::ListShape.new(name: 'BatchGetPolicyErrorList')
+    BatchGetPolicyInput = Shapes::StructureShape.new(name: 'BatchGetPolicyInput')
+    BatchGetPolicyInputItem = Shapes::StructureShape.new(name: 'BatchGetPolicyInputItem')
+    BatchGetPolicyInputList = Shapes::ListShape.new(name: 'BatchGetPolicyInputList')
+    BatchGetPolicyOutput = Shapes::StructureShape.new(name: 'BatchGetPolicyOutput')
+    BatchGetPolicyOutputItem = Shapes::StructureShape.new(name: 'BatchGetPolicyOutputItem')
+    BatchGetPolicyOutputList = Shapes::ListShape.new(name: 'BatchGetPolicyOutputList')
     BatchIsAuthorizedInput = Shapes::StructureShape.new(name: 'BatchIsAuthorizedInput')
     BatchIsAuthorizedInputItem = Shapes::StructureShape.new(name: 'BatchIsAuthorizedInputItem')
     BatchIsAuthorizedInputList = Shapes::ListShape.new(name: 'BatchIsAuthorizedInputList')
@@ -59,6 +68,7 @@ module Aws::VerifiedPermissions
     CreatePolicyStoreOutput = Shapes::StructureShape.new(name: 'CreatePolicyStoreOutput')
     CreatePolicyTemplateInput = Shapes::StructureShape.new(name: 'CreatePolicyTemplateInput')
     CreatePolicyTemplateOutput = Shapes::StructureShape.new(name: 'CreatePolicyTemplateOutput')
+    Decimal = Shapes::StringShape.new(name: 'Decimal')
     Decision = Shapes::StringShape.new(name: 'Decision')
     DeleteIdentitySourceInput = Shapes::StructureShape.new(name: 'DeleteIdentitySourceInput')
     DeleteIdentitySourceOutput = Shapes::StructureShape.new(name: 'DeleteIdentitySourceOutput')
@@ -102,6 +112,7 @@ module Aws::VerifiedPermissions
     IdentitySourceItemDetails = Shapes::StructureShape.new(name: 'IdentitySourceItemDetails')
     IdentitySources = Shapes::ListShape.new(name: 'IdentitySources')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
+    IpAddr = Shapes::StringShape.new(name: 'IpAddr')
     IsAuthorizedInput = Shapes::StructureShape.new(name: 'IsAuthorizedInput')
     IsAuthorizedOutput = Shapes::StructureShape.new(name: 'IsAuthorizedOutput')
     IsAuthorizedWithTokenInput = Shapes::StructureShape.new(name: 'IsAuthorizedWithTokenInput')
@@ -221,6 +232,8 @@ module Aws::VerifiedPermissions
     AttributeValue.add_member(:string, Shapes::ShapeRef.new(shape: StringAttribute, location_name: "string"))
     AttributeValue.add_member(:set, Shapes::ShapeRef.new(shape: SetAttribute, location_name: "set"))
     AttributeValue.add_member(:record, Shapes::ShapeRef.new(shape: RecordAttribute, location_name: "record"))
+    AttributeValue.add_member(:ipaddr, Shapes::ShapeRef.new(shape: IpAddr, location_name: "ipaddr"))
+    AttributeValue.add_member(:decimal, Shapes::ShapeRef.new(shape: Decimal, location_name: "decimal"))
     AttributeValue.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
     AttributeValue.add_member_subclass(:boolean, Types::AttributeValue::Boolean)
     AttributeValue.add_member_subclass(:entity_identifier, Types::AttributeValue::EntityIdentifier)
@@ -228,11 +241,44 @@ module Aws::VerifiedPermissions
     AttributeValue.add_member_subclass(:string, Types::AttributeValue::String)
     AttributeValue.add_member_subclass(:set, Types::AttributeValue::Set)
     AttributeValue.add_member_subclass(:record, Types::AttributeValue::Record)
+    AttributeValue.add_member_subclass(:ipaddr, Types::AttributeValue::Ipaddr)
+    AttributeValue.add_member_subclass(:decimal, Types::AttributeValue::Decimal)
     AttributeValue.add_member_subclass(:unknown, Types::AttributeValue::Unknown)
     AttributeValue.struct_class = Types::AttributeValue
 
     Audiences.member = Shapes::ShapeRef.new(shape: Audience)
 
+    BatchGetPolicyErrorItem.add_member(:code, Shapes::ShapeRef.new(shape: BatchGetPolicyErrorCode, required: true, location_name: "code"))
+    BatchGetPolicyErrorItem.add_member(:policy_store_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "policyStoreId"))
+    BatchGetPolicyErrorItem.add_member(:policy_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "policyId"))
+    BatchGetPolicyErrorItem.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
+    BatchGetPolicyErrorItem.struct_class = Types::BatchGetPolicyErrorItem
+
+    BatchGetPolicyErrorList.member = Shapes::ShapeRef.new(shape: BatchGetPolicyErrorItem)
+
+    BatchGetPolicyInput.add_member(:requests, Shapes::ShapeRef.new(shape: BatchGetPolicyInputList, required: true, location_name: "requests"))
+    BatchGetPolicyInput.struct_class = Types::BatchGetPolicyInput
+
+    BatchGetPolicyInputItem.add_member(:policy_store_id, Shapes::ShapeRef.new(shape: PolicyStoreId, required: true, location_name: "policyStoreId"))
+    BatchGetPolicyInputItem.add_member(:policy_id, Shapes::ShapeRef.new(shape: PolicyId, required: true, location_name: "policyId"))
+    BatchGetPolicyInputItem.struct_class = Types::BatchGetPolicyInputItem
+
+    BatchGetPolicyInputList.member = Shapes::ShapeRef.new(shape: BatchGetPolicyInputItem)
+
+    BatchGetPolicyOutput.add_member(:results, Shapes::ShapeRef.new(shape: BatchGetPolicyOutputList, required: true, location_name: "results"))
+    BatchGetPolicyOutput.add_member(:errors, Shapes::ShapeRef.new(shape: BatchGetPolicyErrorList, required: true, location_name: "errors"))
+    BatchGetPolicyOutput.struct_class = Types::BatchGetPolicyOutput
+
+    BatchGetPolicyOutputItem.add_member(:policy_store_id, Shapes::ShapeRef.new(shape: PolicyStoreId, required: true, location_name: "policyStoreId"))
+    BatchGetPolicyOutputItem.add_member(:policy_id, Shapes::ShapeRef.new(shape: PolicyId, required: true, location_name: "policyId"))
+    BatchGetPolicyOutputItem.add_member(:policy_type, Shapes::ShapeRef.new(shape: PolicyType, required: true, location_name: "policyType"))
+    BatchGetPolicyOutputItem.add_member(:definition, Shapes::ShapeRef.new(shape: PolicyDefinitionDetail, required: true, location_name: "definition"))
+    BatchGetPolicyOutputItem.add_member(:created_date, Shapes::ShapeRef.new(shape: TimestampFormat, required: true, location_name: "createdDate"))
+    BatchGetPolicyOutputItem.add_member(:last_updated_date, Shapes::ShapeRef.new(shape: TimestampFormat, required: true, location_name: "lastUpdatedDate"))
+    BatchGetPolicyOutputItem.struct_class = Types::BatchGetPolicyOutputItem
+
+    BatchGetPolicyOutputList.member = Shapes::ShapeRef.new(shape: BatchGetPolicyOutputItem)
+
     BatchIsAuthorizedInput.add_member(:policy_store_id, Shapes::ShapeRef.new(shape: PolicyStoreId, required: true, location_name: "policyStoreId"))
     BatchIsAuthorizedInput.add_member(:entities, Shapes::ShapeRef.new(shape: EntitiesDefinition, location_name: "entities"))
     BatchIsAuthorizedInput.add_member(:requests, Shapes::ShapeRef.new(shape: BatchIsAuthorizedInputList, required: true, location_name: "requests"))
@@ -969,6 +1015,18 @@ module Aws::VerifiedPermissions
         "uid" => "verifiedpermissions-2021-12-01",
       }
 
+      api.add_operation(:batch_get_policy, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchGetPolicy"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: BatchGetPolicyInput)
+        o.output = Shapes::ShapeRef.new(shape: BatchGetPolicyOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:batch_is_authorized, Seahorse::Model::Operation.new.tap do |o|
         o.name = "BatchIsAuthorized"
         o.http_method = "POST"

data/lib/aws-sdk-verifiedpermissions/types.rb

@@ -30,7 +30,7 @@ module Aws::VerifiedPermissions
     # [IsAuthorized][1], [BatchIsAuthorized][2], and
     # [IsAuthorizedWithToken][3] operations.
     #
-    # Example: `\{ "actionId": "<action name>", "actionType": "Action" \}`
+    # Example: `{ "actionId": "<action name>", "actionType": "Action" }`
     #
     #
     #
@@ -79,7 +79,7 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] boolean
     #   An attribute value of [Boolean][1] type.
     #
-    #   Example: `\{"boolean": true\}`
+    #   Example: `{"boolean": true}`
     #
     #
     #
@@ -89,8 +89,8 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] entity_identifier
     #   An attribute value of type [EntityIdentifier][1].
     #
-    #   Example: `"entityIdentifier": \{ "entityId": "<id>", "entityType":
-    #   "<entity type>"\}`
+    #   Example: `"entityIdentifier": { "entityId": "<id>", "entityType":
+    #   "<entity type>"}`
     #
     #
     #
@@ -100,7 +100,7 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] long
     #   An attribute value of [Long][1] type.
     #
-    #   Example: `\{"long": 0\}`
+    #   Example: `{"long": 0}`
     #
     #
     #
@@ -110,7 +110,7 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] string
     #   An attribute value of [String][1] type.
     #
-    #   Example: `\{"string": "abc"\}`
+    #   Example: `{"string": "abc"}`
     #
     #
     #
@@ -120,7 +120,7 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] set
     #   An attribute value of [Set][1] type.
     #
-    #   Example: `\{"set": [ \{\} ] \}`
+    #   Example: `{"set": [ {} ] }`
     #
     #
     #
@@ -130,13 +130,33 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] record
     #   An attribute value of [Record][1] type.
     #
-    #   Example: `\{"record": \{ "keyName": \{\} \} \}`
+    #   Example: `{"record": { "keyName": {} } }`
     #
     #
     #
     #   [1]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record
     #   @return [Hash<String,Types::AttributeValue>]
     #
+    # @!attribute [rw] ipaddr
+    #   An attribute value of [ipaddr][1] type.
+    #
+    #   Example: `{"ip": "192.168.1.100"}`
+    #
+    #
+    #
+    #   [1]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#datatype-ipaddr
+    #   @return [String]
+    #
+    # @!attribute [rw] decimal
+    #   An attribute value of [decimal][1] type.
+    #
+    #   Example: `{"decimal": "1.1"}`
+    #
+    #
+    #
+    #   [1]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#datatype-decimal
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/AttributeValue AWS API Documentation
     #
     class AttributeValue < Struct.new(
@@ -146,8 +166,10 @@ module Aws::VerifiedPermissions
       :string,
       :set,
       :record,
+      :ipaddr,
+      :decimal,
       :unknown)
-      SENSITIVE = [:boolean, :long, :string]
+      SENSITIVE = [:boolean, :long, :string, :ipaddr, :decimal]
       include Aws::Structure
       include Aws::Structure::Union
 
@@ -157,9 +179,140 @@ module Aws::VerifiedPermissions
       class String < AttributeValue; end
       class Set < AttributeValue; end
       class Record < AttributeValue; end
+      class Ipaddr < AttributeValue; end
+      class Decimal < AttributeValue; end
       class Unknown < AttributeValue; end
     end
 
+    # Contains the information about an error resulting from a
+    # `BatchGetPolicy` API call.
+    #
+    # @!attribute [rw] code
+    #   The error code that was returned.
+    #   @return [String]
+    #
+    # @!attribute [rw] policy_store_id
+    #   The identifier of the policy store associated with the failed
+    #   request.
+    #   @return [String]
+    #
+    # @!attribute [rw] policy_id
+    #   The identifier of the policy associated with the failed request.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   A detailed error message.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchGetPolicyErrorItem AWS API Documentation
+    #
+    class BatchGetPolicyErrorItem < Struct.new(
+      :code,
+      :policy_store_id,
+      :policy_id,
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] requests
+    #   An array of up to 100 policies you want information about.
+    #   @return [Array<Types::BatchGetPolicyInputItem>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchGetPolicyInput AWS API Documentation
+    #
+    class BatchGetPolicyInput < Struct.new(
+      :requests)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Information about a policy that you include in a `BatchGetPolicy` API
+    # request.
+    #
+    # @!attribute [rw] policy_store_id
+    #   The identifier of the policy store where the policy you want
+    #   information about is stored.
+    #   @return [String]
+    #
+    # @!attribute [rw] policy_id
+    #   The identifier of the policy you want information about.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchGetPolicyInputItem AWS API Documentation
+    #
+    class BatchGetPolicyInputItem < Struct.new(
+      :policy_store_id,
+      :policy_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] results
+    #   Information about the policies listed in the request that were
+    #   successfully returned. These results are returned in the order they
+    #   were requested.
+    #   @return [Array<Types::BatchGetPolicyOutputItem>]
+    #
+    # @!attribute [rw] errors
+    #   Information about the policies from the request that resulted in an
+    #   error. These results are returned in the order they were requested.
+    #   @return [Array<Types::BatchGetPolicyErrorItem>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchGetPolicyOutput AWS API Documentation
+    #
+    class BatchGetPolicyOutput < Struct.new(
+      :results,
+      :errors)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains information about a policy returned from a `BatchGetPolicy`
+    # API request.
+    #
+    # @!attribute [rw] policy_store_id
+    #   The identifier of the policy store where the policy you want
+    #   information about is stored.
+    #   @return [String]
+    #
+    # @!attribute [rw] policy_id
+    #   The identifier of the policy you want information about.
+    #   @return [String]
+    #
+    # @!attribute [rw] policy_type
+    #   The type of the policy. This is one of the following values:
+    #
+    #   * `STATIC`
+    #
+    #   * `TEMPLATE_LINKED`
+    #   @return [String]
+    #
+    # @!attribute [rw] definition
+    #   The policy definition of an item in the list of policies returned.
+    #   @return [Types::PolicyDefinitionDetail]
+    #
+    # @!attribute [rw] created_date
+    #   The date and time the policy was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date
+    #   The date and time the policy was most recently updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchGetPolicyOutputItem AWS API Documentation
+    #
+    class BatchGetPolicyOutputItem < Struct.new(
+      :policy_store_id,
+      :policy_id,
+      :policy_type,
+      :definition,
+      :created_date,
+      :last_updated_date)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] policy_store_id
     #   Specifies the ID of the policy store. Policies in this policy store
     #   will be used to make the authorization decisions for the input.
@@ -228,7 +381,8 @@ module Aws::VerifiedPermissions
 
     # @!attribute [rw] results
     #   A series of `Allow` or `Deny` decisions for each request, and the
-    #   policies that produced them.
+    #   policies that produced them. These results are returned in the order
+    #   they were requested.
     #   @return [Array<Types::BatchIsAuthorizedOutputItem>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchIsAuthorizedOutput AWS API Documentation
@@ -373,7 +527,8 @@ module Aws::VerifiedPermissions
     #
     # @!attribute [rw] results
     #   A series of `Allow` or `Deny` decisions for each request, and the
-    #   policies that produced them.
+    #   policies that produced them. These results are returned in the order
+    #   they were requested.
     #   @return [Array<Types::BatchIsAuthorizedWithTokenOutputItem>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/BatchIsAuthorizedWithTokenOutput AWS API Documentation
@@ -503,9 +658,9 @@ module Aws::VerifiedPermissions
     # This data type part of a [Configuration][1] structure that is used as
     # a parameter to [CreateIdentitySource][2].
     #
-    # Example:`"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
+    # Example:`"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
     # ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration":
-    # \{"groupEntityType": "MyCorp::Group"\}\}`
+    # {"groupEntityType": "MyCorp::Group"}}`
     #
     #
     #
@@ -554,9 +709,9 @@ module Aws::VerifiedPermissions
     # [ConfigurationDetail][1] structure that is part of the response to
     # [GetIdentitySource][2].
     #
-    # Example:`"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
+    # Example:`"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
     # ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration":
-    # \{"groupEntityType": "MyCorp::Group"\}\}`
+    # {"groupEntityType": "MyCorp::Group"}}`
     #
     #
     #
@@ -614,9 +769,9 @@ module Aws::VerifiedPermissions
     # [ConfigurationItem][1] structure that is part of the response to
     # [ListIdentitySources][2].
     #
-    # Example:`"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
+    # Example:`"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
     # ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration":
-    # \{"groupEntityType": "MyCorp::Group"\}\}`
+    # {"groupEntityType": "MyCorp::Group"}}`
     #
     #
     #
@@ -685,9 +840,9 @@ module Aws::VerifiedPermissions
     #   Amazon Cognito user pool and one or more application client IDs.
     #
     #   Example:
-    #   `"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
+    #   `"configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
     #   ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration":
-    #   \{"groupEntityType": "MyCorp::Group"\}\}\}`
+    #   {"groupEntityType": "MyCorp::Group"}}}`
     #
     #
     #
@@ -701,7 +856,7 @@ module Aws::VerifiedPermissions
     #   issuer URL, token type that you want to use, and policy store entity
     #   details.
     #
-    #   Example:`"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}`
+    #   Example:`"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}`
     #   @return [Types::OpenIdConnectConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/Configuration AWS API Documentation
@@ -738,9 +893,9 @@ module Aws::VerifiedPermissions
     #   assign to user groups, and one or more application client IDs.
     #
     #   Example:
-    #   `"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
+    #   `"configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
     #   ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration":
-    #   \{"groupEntityType": "MyCorp::Group"\}\}\}`
+    #   {"groupEntityType": "MyCorp::Group"}}}`
     #
     #
     #
@@ -754,7 +909,7 @@ module Aws::VerifiedPermissions
     #   issuer URL, token type that you want to use, and policy store entity
     #   details.
     #
-    #   Example:`"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}`
+    #   Example:`"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}`
     #   @return [Types::OpenIdConnectConfigurationDetail]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/ConfigurationDetail AWS API Documentation
@@ -791,9 +946,9 @@ module Aws::VerifiedPermissions
     #   assign to user groups, and one or more application client IDs.
     #
     #   Example:
-    #   `"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
+    #   `"configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
     #   ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration":
-    #   \{"groupEntityType": "MyCorp::Group"\}\}\}`
+    #   {"groupEntityType": "MyCorp::Group"}}}`
     #
     #
     #
@@ -807,7 +962,7 @@ module Aws::VerifiedPermissions
     #   issuer URL, token type that you want to use, and policy store entity
     #   details.
     #
-    #   Example:`"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}`
+    #   Example:`"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}`
     #   @return [Types::OpenIdConnectConfigurationItem]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/ConfigurationItem AWS API Documentation
@@ -853,7 +1008,7 @@ module Aws::VerifiedPermissions
     # [IsAuthorizedWithToken][3] operations.
     #
     # Example:
-    # `"context":\{"contextMap":\{"<KeyName1>":\{"boolean":true\},"<KeyName2>":\{"long":1234\}\}\}`
+    # `"context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}`
     #
     #
     #
@@ -871,7 +1026,7 @@ module Aws::VerifiedPermissions
     #   map of a data type and its value.
     #
     #   Example:
-    #   `"contextMap":\{"<KeyName1>":\{"boolean":true\},"<KeyName2>":\{"long":1234\}\}`
+    #   `"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}`
     #   @return [Hash<String,Types::AttributeValue>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/ContextDefinition AWS API Documentation
@@ -1046,9 +1201,9 @@ module Aws::VerifiedPermissions
     #
     # @!attribute [rw] actions
     #   The action that a policy permits or forbids. For example,
-    #   `\{"actions": [\{"actionId": "ViewPhoto", "actionType":
-    #   "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType":
-    #   "PhotoFlash::Action"\}]\}`.
+    #   `{"actions": [{"actionId": "ViewPhoto", "actionType":
+    #   "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType":
+    #   "PhotoFlash::Action"}]}`.
     #   @return [Array<Types::ActionIdentifier>]
     #
     # @!attribute [rw] created_date
@@ -1336,7 +1491,7 @@ module Aws::VerifiedPermissions
     # [IsAuthorizedWithToken][3] operations.
     #
     # Example:
-    # `"determiningPolicies":[\{"policyId":"SPEXAMPLEabcdefg111111"\}]`
+    # `"determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}]`
     #
     #
     #
@@ -1398,7 +1553,7 @@ module Aws::VerifiedPermissions
     # operation, and as a response parameter for the [CreatePolicy][2],
     # [GetPolicy][3], and [UpdatePolicy][4] operations.
     #
-    # Example: `\{"entityId":"string","entityType":"string"\}`
+    # Example: `{"entityId":"string","entityType":"string"}`
     #
     #
     #
@@ -1434,9 +1589,9 @@ module Aws::VerifiedPermissions
     # This data type is used as one of the fields in the
     # [EntitiesDefinition][1] structure.
     #
-    # `\{ "identifier": \{ "entityType": "Photo", "entityId":
-    # "VacationPhoto94.jpg" \}, "attributes": \{\}, "parents": [ \{
-    # "entityType": "Album", "entityId": "alice_folder" \} ] \}`
+    # `{ "identifier": { "entityType": "Photo", "entityId":
+    # "VacationPhoto94.jpg" }, "attributes": {}, "parents": [ {
+    # "entityType": "Album", "entityId": "alice_folder" } ] }`
     #
     #
     #
@@ -1641,9 +1796,9 @@ module Aws::VerifiedPermissions
     #
     # @!attribute [rw] actions
     #   The action that a policy permits or forbids. For example,
-    #   `\{"actions": [\{"actionId": "ViewPhoto", "actionType":
-    #   "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType":
-    #   "PhotoFlash::Action"\}]\}`.
+    #   `{"actions": [{"actionId": "ViewPhoto", "actionType":
+    #   "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType":
+    #   "PhotoFlash::Action"}]}`.
     #   @return [Array<Types::ActionIdentifier>]
     #
     # @!attribute [rw] definition
@@ -3214,7 +3369,7 @@ module Aws::VerifiedPermissions
     # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html
     #
     # @!attribute [rw] policy_store_id
-    #   The identifier of the PolicyStore where the policy you want
+    #   The identifier of the policy store where the policy you want
     #   information about is stored.
     #   @return [String]
     #
@@ -3240,9 +3395,9 @@ module Aws::VerifiedPermissions
     #
     # @!attribute [rw] actions
     #   The action that a policy permits or forbids. For example,
-    #   `\{"actions": [\{"actionId": "ViewPhoto", "actionType":
-    #   "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType":
-    #   "PhotoFlash::Action"\}]\}`.
+    #   `{"actions": [{"actionId": "ViewPhoto", "actionType":
+    #   "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType":
+    #   "PhotoFlash::Action"}]}`.
     #   @return [Array<Types::ActionIdentifier>]
     #
     # @!attribute [rw] definition
@@ -3463,7 +3618,7 @@ module Aws::VerifiedPermissions
     # @!attribute [rw] cedar_json
     #   A JSON string representation of the schema supported by applications
     #   that use this policy store. To delete the schema, run [PutSchema][1]
-    #   with `\{\}` for this parameter. For more information, see [Policy
+    #   with `{}` for this parameter. For more information, see [Policy
     #   store schema][2] in the *Amazon Verified Permissions User Guide*.
     #
     #
@@ -4155,9 +4310,9 @@ module Aws::VerifiedPermissions
     #
     # @!attribute [rw] actions
     #   The action that a policy permits or forbids. For example,
-    #   `\{"actions": [\{"actionId": "ViewPhoto", "actionType":
-    #   "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType":
-    #   "PhotoFlash::Action"\}]\}`.
+    #   `{"actions": [{"actionId": "ViewPhoto", "actionType":
+    #   "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType":
+    #   "PhotoFlash::Action"}]}`.
     #   @return [Array<Types::ActionIdentifier>]
     #
     # @!attribute [rw] created_date

data/lib/aws-sdk-verifiedpermissions.rb

@@ -23,7 +23,7 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:verifiedpermissions)
 # structure.
 #
 #     verified_permissions = Aws::VerifiedPermissions::Client.new
-#     resp = verified_permissions.batch_is_authorized(params)
+#     resp = verified_permissions.batch_get_policy(params)
 #
 # See {Client} for more information.
 #
@@ -55,7 +55,7 @@ module Aws::VerifiedPermissions
   autoload :EndpointProvider, 'aws-sdk-verifiedpermissions/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-verifiedpermissions/endpoints'
 
-  GEM_VERSION = '1.36.0'
+  GEM_VERSION = '1.37.0'
 
 end
 

data/sig/client.rbs

@@ -76,6 +76,22 @@ module Aws
                   | (?Hash[Symbol, untyped]) -> instance
 
 
+      interface _BatchGetPolicyResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetPolicyOutput]
+        def results: () -> ::Array[Types::BatchGetPolicyOutputItem]
+        def errors: () -> ::Array[Types::BatchGetPolicyErrorItem]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/VerifiedPermissions/Client.html#batch_get_policy-instance_method
+      def batch_get_policy: (
+                              requests: Array[
+                                {
+                                  policy_store_id: ::String,
+                                  policy_id: ::String
+                                },
+                              ]
+                            ) -> _BatchGetPolicyResponseSuccess
+                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchGetPolicyResponseSuccess
+
       interface _BatchIsAuthorizedResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::BatchIsAuthorizedOutput]
         def results: () -> ::Array[Types::BatchIsAuthorizedOutputItem]

data/sig/types.rbs

@@ -26,8 +26,10 @@ module Aws::VerifiedPermissions
       attr_accessor string: ::String
       attr_accessor set: ::Array[Types::AttributeValue]
       attr_accessor record: ::Hash[::String, Types::AttributeValue]
+      attr_accessor ipaddr: ::String
+      attr_accessor decimal: ::String
       attr_accessor unknown: untyped
-      SENSITIVE: [:boolean, :long, :string]
+      SENSITIVE: [:boolean, :long, :string, :ipaddr, :decimal]
 
       class Boolean < AttributeValue
       end
@@ -41,10 +43,49 @@ module Aws::VerifiedPermissions
       end
       class Record < AttributeValue
       end
+      class Ipaddr < AttributeValue
+      end
+      class Decimal < AttributeValue
+      end
       class Unknown < AttributeValue
       end
     end
 
+    class BatchGetPolicyErrorItem
+      attr_accessor code: ("POLICY_STORE_NOT_FOUND" | "POLICY_NOT_FOUND")
+      attr_accessor policy_store_id: ::String
+      attr_accessor policy_id: ::String
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class BatchGetPolicyInput
+      attr_accessor requests: ::Array[Types::BatchGetPolicyInputItem]
+      SENSITIVE: []
+    end
+
+    class BatchGetPolicyInputItem
+      attr_accessor policy_store_id: ::String
+      attr_accessor policy_id: ::String
+      SENSITIVE: []
+    end
+
+    class BatchGetPolicyOutput
+      attr_accessor results: ::Array[Types::BatchGetPolicyOutputItem]
+      attr_accessor errors: ::Array[Types::BatchGetPolicyErrorItem]
+      SENSITIVE: []
+    end
+
+    class BatchGetPolicyOutputItem
+      attr_accessor policy_store_id: ::String
+      attr_accessor policy_id: ::String
+      attr_accessor policy_type: ("STATIC" | "TEMPLATE_LINKED")
+      attr_accessor definition: Types::PolicyDefinitionDetail
+      attr_accessor created_date: ::Time
+      attr_accessor last_updated_date: ::Time
+      SENSITIVE: []
+    end
+
     class BatchIsAuthorizedInput
       attr_accessor policy_store_id: ::String
       attr_accessor entities: Types::EntitiesDefinition

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-verifiedpermissions
 version: !ruby/object:Gem::Version
-  version: 1.36.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core