aws-sdk-deadline 1.62.0 → 1.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a28e7c6dea9bbb1e19450476d753949498ca5d6a00d06db6c3c00835e42c392d
-  data.tar.gz: f005ee7b193ca9fb43081c98cbb7bb91922a05df3722a936872ccca900cb2d4f
+  metadata.gz: c0d962d16a487f033b77bbb888a8e9d2c8f3f3d0d22ffa4054c3b95b905fcdcf
+  data.tar.gz: 2938c502887edfb62d8a6f69ad03913a0f93bbde260e9d7e7328afc6ea9064df
 SHA512:
-  metadata.gz: 98b0efb162516b1b1a15efd6f91b1a2fbaebfc231ccf07305c9321baa8c8b1ce895c1260f82e289fdb8168e776ce13d09b1f43b42afca4c974ac474f4ee1bf5c
-  data.tar.gz: 39951620c1fb28973f28acc6de6862f2890f65a71f34a8ecea51d90903ad05668c20f948e8941d6f103c93386509c2f8570323d022b7c290f6614371b4c6398b
+  metadata.gz: f86f29a344bd47b1e4ecdab3f42f5cef6b05029c191c1dd0ba80335c5b9836e23715348df84b0ca2fb42bc71c592ec199ebbaa8a46bc5ce81892f1bc61021497
+  data.tar.gz: 2ef1ab43aac06887c92dbebd751cc4ea9916c7373a6417133a1f2ad8fbe588b87d77bdc4499593a97b32273088dfab9885ac74389e4f5ba1467adf897d4d1754

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.63.0 (2026-10-09)
+------------------
+
+* Feature - The new ListMemberships API enables users to discover their memberships across Deadline Cloud resources, enabling scoped users of Deadline resources to discover and interact with the resources they have been provided scoped access to.
+
 1.62.0 (2026-09-29)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.62.0
+1.63.0

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

@@ -5522,6 +5522,111 @@ module Aws::Deadline
       req.send_request(options)
     end
 
+    # Lists the Deadline Cloud resource memberships associated with a
+    # specified IAM Identity Center principal, optionally filtered by the
+    # requested resource types.
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results, or `null` to start from the
+    #   beginning.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return. Use this parameter with
+    #   `NextToken` to get results as a set of sequential pages.
+    #
+    # @option params [required, String] :principal_id
+    #   The ID of the IAM Identity Center principal whose Deadline Cloud
+    #   resource memberships you want to list.
+    #
+    # @option params [String] :identity_store_id
+    #   The identity store ID that contains the principal. This parameter is
+    #   required for callers that do not use a monitor session.
+    #
+    # @option params [String] :identity_center_region
+    #   The Region of the IAM Identity Center instance. If not provided, the
+    #   service defaults to the Amazon Web Services Region in which you make
+    #   the request.
+    #
+    # @option params [Array<String>] :resource_types
+    #   The resource types to include when listing the principal's
+    #   memberships. If not specified, memberships for all supported resource
+    #   types are returned.
+    #
+    # @return [Types::ListMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListMembershipsResponse#memberships #memberships} => Array&lt;Types::MembershipSummary&gt;
+    #   * {Types::ListMembershipsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    #
+    # @example Example: List memberships using a cross-region identity store
+    #
+    #   resp = client.list_memberships({
+    #     identity_center_region: "us-east-1", 
+    #     identity_store_id: "d-1234567890", 
+    #     principal_id: "12345678-1234-1234-1234-123456789abc", 
+    #     resource_types: [
+    #       "QUEUE", 
+    #       "JOB", 
+    #     ], 
+    #   })
+    #
+    # @example Example: List a Monitor user's memberships of every resource type
+    #
+    #   resp = client.list_memberships({
+    #     principal_id: "12345678-1234-1234-1234-123456789abc", 
+    #   })
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_memberships({
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     principal_id: "IdentityCenterPrincipalId", # required
+    #     identity_store_id: "IdentityStoreId",
+    #     identity_center_region: "Region",
+    #     resource_types: ["FARM"], # accepts FARM, QUEUE, FLEET, JOB
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.memberships #=> Array
+    #   resp.memberships[0].farm.farm_id #=> String
+    #   resp.memberships[0].farm.principal_id #=> String
+    #   resp.memberships[0].farm.principal_type #=> String, one of "USER", "GROUP"
+    #   resp.memberships[0].farm.identity_store_id #=> String
+    #   resp.memberships[0].farm.membership_level #=> String, one of "VIEWER", "CONTRIBUTOR", "OWNER", "MANAGER"
+    #   resp.memberships[0].queue.farm_id #=> String
+    #   resp.memberships[0].queue.queue_id #=> String
+    #   resp.memberships[0].queue.principal_id #=> String
+    #   resp.memberships[0].queue.principal_type #=> String, one of "USER", "GROUP"
+    #   resp.memberships[0].queue.identity_store_id #=> String
+    #   resp.memberships[0].queue.membership_level #=> String, one of "VIEWER", "CONTRIBUTOR", "OWNER", "MANAGER"
+    #   resp.memberships[0].fleet.farm_id #=> String
+    #   resp.memberships[0].fleet.fleet_id #=> String
+    #   resp.memberships[0].fleet.principal_id #=> String
+    #   resp.memberships[0].fleet.principal_type #=> String, one of "USER", "GROUP"
+    #   resp.memberships[0].fleet.identity_store_id #=> String
+    #   resp.memberships[0].fleet.membership_level #=> String, one of "VIEWER", "CONTRIBUTOR", "OWNER", "MANAGER"
+    #   resp.memberships[0].job.farm_id #=> String
+    #   resp.memberships[0].job.queue_id #=> String
+    #   resp.memberships[0].job.job_id #=> String
+    #   resp.memberships[0].job.principal_id #=> String
+    #   resp.memberships[0].job.principal_type #=> String, one of "USER", "GROUP"
+    #   resp.memberships[0].job.identity_store_id #=> String
+    #   resp.memberships[0].job.membership_level #=> String, one of "VIEWER", "CONTRIBUTOR", "OWNER", "MANAGER"
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListMemberships AWS API Documentation
+    #
+    # @overload list_memberships(params = {})
+    # @param [Hash] params ({})
+    def list_memberships(params = {}, options = {})
+      req = build_request(:list_memberships, params)
+      req.send_request(options)
+    end
+
     # Lists metered products.
     #
     # @option params [required, String] :license_endpoint_id
@@ -8466,7 +8571,7 @@ module Aws::Deadline
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-deadline'
-      context[:gem_version] = '1.62.0'
+      context[:gem_version] = '1.63.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -429,6 +429,8 @@ module Aws::Deadline
     ListLicenseEndpointsResponse = Shapes::StructureShape.new(name: 'ListLicenseEndpointsResponse')
     ListLimitsRequest = Shapes::StructureShape.new(name: 'ListLimitsRequest')
     ListLimitsResponse = Shapes::StructureShape.new(name: 'ListLimitsResponse')
+    ListMembershipsRequest = Shapes::StructureShape.new(name: 'ListMembershipsRequest')
+    ListMembershipsResponse = Shapes::StructureShape.new(name: 'ListMembershipsResponse')
     ListMeteredProductsRequest = Shapes::StructureShape.new(name: 'ListMeteredProductsRequest')
     ListMeteredProductsResponse = Shapes::StructureShape.new(name: 'ListMeteredProductsResponse')
     ListMonitorsRequest = Shapes::StructureShape.new(name: 'ListMonitorsRequest')
@@ -487,6 +489,10 @@ module Aws::Deadline
     MaxRetriesPerTask = Shapes::IntegerShape.new(name: 'MaxRetriesPerTask')
     MaxWorkerCount = Shapes::IntegerShape.new(name: 'MaxWorkerCount')
     MembershipLevel = Shapes::StringShape.new(name: 'MembershipLevel')
+    MembershipResourceType = Shapes::StringShape.new(name: 'MembershipResourceType')
+    MembershipResourceTypes = Shapes::ListShape.new(name: 'MembershipResourceTypes')
+    MembershipSummaries = Shapes::ListShape.new(name: 'MembershipSummaries')
+    MembershipSummary = Shapes::UnionShape.new(name: 'MembershipSummary')
     MemoryAmountMiB = Shapes::IntegerShape.new(name: 'MemoryAmountMiB')
     MemoryMiBRange = Shapes::StructureShape.new(name: 'MemoryMiBRange')
     MeteredProductId = Shapes::StringShape.new(name: 'MeteredProductId')
@@ -2537,6 +2543,18 @@ module Aws::Deadline
     ListLimitsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListLimitsResponse.struct_class = Types::ListLimitsResponse
 
+    ListMembershipsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListMembershipsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListMembershipsRequest.add_member(:principal_id, Shapes::ShapeRef.new(shape: IdentityCenterPrincipalId, required: true, location: "querystring", location_name: "principalId"))
+    ListMembershipsRequest.add_member(:identity_store_id, Shapes::ShapeRef.new(shape: IdentityStoreId, location: "querystring", location_name: "identityStoreId"))
+    ListMembershipsRequest.add_member(:identity_center_region, Shapes::ShapeRef.new(shape: Region, location: "querystring", location_name: "identityCenterRegion"))
+    ListMembershipsRequest.add_member(:resource_types, Shapes::ShapeRef.new(shape: MembershipResourceTypes, location: "querystring", location_name: "resourceTypes"))
+    ListMembershipsRequest.struct_class = Types::ListMembershipsRequest
+
+    ListMembershipsResponse.add_member(:memberships, Shapes::ShapeRef.new(shape: MembershipSummaries, required: true, location_name: "memberships"))
+    ListMembershipsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListMembershipsResponse.struct_class = Types::ListMembershipsResponse
+
     ListMeteredProductsRequest.add_member(:license_endpoint_id, Shapes::ShapeRef.new(shape: LicenseEndpointId, required: true, location: "uri", location_name: "licenseEndpointId"))
     ListMeteredProductsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
     ListMeteredProductsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
@@ -2758,6 +2776,22 @@ module Aws::Deadline
 
     ManifestPropertiesList.member = Shapes::ShapeRef.new(shape: ManifestProperties)
 
+    MembershipResourceTypes.member = Shapes::ShapeRef.new(shape: MembershipResourceType)
+
+    MembershipSummaries.member = Shapes::ShapeRef.new(shape: MembershipSummary)
+
+    MembershipSummary.add_member(:farm, Shapes::ShapeRef.new(shape: FarmMember, location_name: "farm"))
+    MembershipSummary.add_member(:queue, Shapes::ShapeRef.new(shape: QueueMember, location_name: "queue"))
+    MembershipSummary.add_member(:fleet, Shapes::ShapeRef.new(shape: FleetMember, location_name: "fleet"))
+    MembershipSummary.add_member(:job, Shapes::ShapeRef.new(shape: JobMember, location_name: "job"))
+    MembershipSummary.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    MembershipSummary.add_member_subclass(:farm, Types::MembershipSummary::Farm)
+    MembershipSummary.add_member_subclass(:queue, Types::MembershipSummary::Queue)
+    MembershipSummary.add_member_subclass(:fleet, Types::MembershipSummary::Fleet)
+    MembershipSummary.add_member_subclass(:job, Types::MembershipSummary::Job)
+    MembershipSummary.add_member_subclass(:unknown, Types::MembershipSummary::Unknown)
+    MembershipSummary.struct_class = Types::MembershipSummary
+
     MemoryMiBRange.add_member(:min, Shapes::ShapeRef.new(shape: MemoryAmountMiB, required: true, location_name: "min"))
     MemoryMiBRange.add_member(:max, Shapes::ShapeRef.new(shape: MemoryAmountMiB, location_name: "max"))
     MemoryMiBRange.struct_class = Types::MemoryMiBRange
@@ -5126,6 +5160,28 @@ module Aws::Deadline
         )
       end)
 
+      api.add_operation(:list_memberships, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListMemberships"
+        o.http_method = "GET"
+        o.http_request_uri = "/2023-10-12/memberships"
+        o.endpoint_pattern = {
+          "hostPrefix" => "management.",
+        }
+        o.input = Shapes::ShapeRef.new(shape: ListMembershipsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListMembershipsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_metered_products, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListMeteredProducts"
         o.http_method = "GET"

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

@@ -8096,6 +8096,79 @@ module Aws::Deadline
       include Aws::Structure
     end
 
+    # Shared pagination fields for List operation inputs (nextToken +
+    # maxResults).
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results, or `null` to start from the
+    #   beginning.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return. Use this parameter with
+    #   `NextToken` to get results as a set of sequential pages.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] principal_id
+    #   The ID of the IAM Identity Center principal whose Deadline Cloud
+    #   resource memberships you want to list.
+    #   @return [String]
+    #
+    # @!attribute [rw] identity_store_id
+    #   The identity store ID that contains the principal. This parameter is
+    #   required for callers that do not use a monitor session.
+    #   @return [String]
+    #
+    # @!attribute [rw] identity_center_region
+    #   The Region of the IAM Identity Center instance. If not provided, the
+    #   service defaults to the Amazon Web Services Region in which you make
+    #   the request.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_types
+    #   The resource types to include when listing the principal's
+    #   memberships. If not specified, memberships for all supported
+    #   resource types are returned.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListMembershipsRequest AWS API Documentation
+    #
+    class ListMembershipsRequest < Struct.new(
+      :next_token,
+      :max_results,
+      :principal_id,
+      :identity_store_id,
+      :identity_center_region,
+      :resource_types)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Shared pagination field for List operation outputs (nextToken).
+    #
+    # @!attribute [rw] memberships
+    #   The memberships associated with the specified principal.
+    #   @return [Array<Types::MembershipSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   If Deadline Cloud returns `nextToken`, then there are more results
+    #   available. The value of `nextToken` is a unique pagination token for
+    #   each page. To retrieve the next page, call the operation again using
+    #   the returned token. Keep all other arguments unchanged. If no
+    #   results remain, then `nextToken` is set to `null`. Each pagination
+    #   token expires after 24 hours. If you provide a token that isn't
+    #   valid, then you receive an HTTP 400 `ValidationException` error.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListMembershipsResponse AWS API Documentation
+    #
+    class ListMembershipsResponse < Struct.new(
+      :memberships,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Shared pagination fields for List operation inputs (nextToken +
     # maxResults).
     #
@@ -9275,6 +9348,47 @@ module Aws::Deadline
       include Aws::Structure
     end
 
+    # A membership record for a principal on a single Deadline Cloud
+    # resource. The summary identifies the resource that the principal is a
+    # member of and the principal's membership level for that resource.
+    #
+    # @note MembershipSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MembershipSummary corresponding to the set member.
+    #
+    # @!attribute [rw] farm
+    #   A membership on a farm.
+    #   @return [Types::FarmMember]
+    #
+    # @!attribute [rw] queue
+    #   A membership on a queue.
+    #   @return [Types::QueueMember]
+    #
+    # @!attribute [rw] fleet
+    #   A membership on a fleet.
+    #   @return [Types::FleetMember]
+    #
+    # @!attribute [rw] job
+    #   A membership on a job.
+    #   @return [Types::JobMember]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/MembershipSummary AWS API Documentation
+    #
+    class MembershipSummary < Struct.new(
+      :farm,
+      :queue,
+      :fleet,
+      :job,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Farm < MembershipSummary; end
+      class Queue < MembershipSummary; end
+      class Fleet < MembershipSummary; end
+      class Job < MembershipSummary; end
+      class Unknown < MembershipSummary; end
+    end
+
     # The range of memory in MiB.
     #
     # @!attribute [rw] min

data/lib/aws-sdk-deadline.rb

@@ -55,7 +55,7 @@ module Aws::Deadline
   autoload :EndpointProvider, 'aws-sdk-deadline/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-deadline/endpoints'
 
-  GEM_VERSION = '1.62.0'
+  GEM_VERSION = '1.63.0'
 
 end
 

data/sig/client.rbs

@@ -1456,6 +1456,22 @@ module Aws
                        ) -> _ListLimitsResponseSuccess
                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListLimitsResponseSuccess
 
+      interface _ListMembershipsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListMembershipsResponse]
+        def memberships: () -> ::Array[Types::MembershipSummary]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Deadline/Client.html#list_memberships-instance_method
+      def list_memberships: (
+                              ?next_token: ::String,
+                              ?max_results: ::Integer,
+                              principal_id: ::String,
+                              ?identity_store_id: ::String,
+                              ?identity_center_region: ::String,
+                              ?resource_types: Array[("FARM" | "QUEUE" | "FLEET" | "JOB")]
+                            ) -> _ListMembershipsResponseSuccess
+                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMembershipsResponseSuccess
+
       interface _ListMeteredProductsResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListMeteredProductsResponse]
         def metered_products: () -> ::Array[Types::MeteredProductSummary]

data/sig/types.rbs

@@ -2137,6 +2137,22 @@ module Aws::Deadline
       SENSITIVE: []
     end
 
+    class ListMembershipsRequest
+      attr_accessor next_token: ::String
+      attr_accessor max_results: ::Integer
+      attr_accessor principal_id: ::String
+      attr_accessor identity_store_id: ::String
+      attr_accessor identity_center_region: ::String
+      attr_accessor resource_types: ::Array[("FARM" | "QUEUE" | "FLEET" | "JOB")]
+      SENSITIVE: []
+    end
+
+    class ListMembershipsResponse
+      attr_accessor memberships: ::Array[Types::MembershipSummary]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
     class ListMeteredProductsRequest
       attr_accessor license_endpoint_id: ::String
       attr_accessor next_token: ::String
@@ -2428,6 +2444,26 @@ module Aws::Deadline
       SENSITIVE: []
     end
 
+    class MembershipSummary
+      attr_accessor farm: Types::FarmMember
+      attr_accessor queue: Types::QueueMember
+      attr_accessor fleet: Types::FleetMember
+      attr_accessor job: Types::JobMember
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class Farm < MembershipSummary
+      end
+      class Queue < MembershipSummary
+      end
+      class Fleet < MembershipSummary
+      end
+      class Job < MembershipSummary
+      end
+      class Unknown < MembershipSummary
+      end
+    end
+
     class MemoryMiBRange
       attr_accessor min: ::Integer
       attr_accessor max: ::Integer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-deadline
 version: !ruby/object:Gem::Version
-  version: 1.62.0
+  version: 1.63.0
 platform: ruby
 authors:
 - Amazon Web Services