aws-sdk-identitystore 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74eb35fd4e09b38b3e9364c109bb006e0e40bc16c3a2ac7a69fd3a9168d06a54
-  data.tar.gz: ae2f00db414a08c08001090044ee924ad054a7e20a088ce2e07f25c2f8b64f32
+  metadata.gz: 72f57866e3abe70a2dafe9c45a1b153840039c8cbf0d5b18d39ec6d883440c7e
+  data.tar.gz: 8e27edcb03aaba73769bbcc0353ef4d570dd7615c286163ea742e8b67dd9bc05
 SHA512:
-  metadata.gz: 8226814f37eddd653af53cf8e4c4037e3e01be73e480d2c8ee83b02d11df4b44bc187dead49e39f25d6cabaf62ba8a07a3468b1c9e7b8c599a37c3ed58cd5498
-  data.tar.gz: 2d9d80dd1410a0855b111a87591e964dc424d36634cc5b9293e22fdd34dc74c53b730723cf6bda19ddac264a49d18e26df13256a68e1f9e601b1139b7f119de8
+  metadata.gz: 305a25e32f4061f36ca673768258ca0c1c51c365bc5db7298c8a57505a61d029835e53c103d27174cfc8803ce91cd133072146cbac77ec1bb8e3d3a030f61fe8
+  data.tar.gz: 4050ac9400e488f8e84671dc1086d72bef9ae885f3eaaf184942a0ad5b4822d727227edb7dfa51dbdc7663a6b3528486a8d688bdb1c7183a5be47c3672a2d513

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.20.0 (2022-09-06)
+------------------
+
+* Feature - Documentation updates for the Identity Store CLI Reference.
+
 1.19.0 (2022-08-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.19.0
+1.20.0

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

@@ -452,9 +452,9 @@ module Aws::IdentityStore
     # @option params [String] :user_name
     #   A unique string used to identify the user. The length limit is 128
     #   characters. This value can consist of letters, accented characters,
-    #   symbols, numbers, and punctuation. The characters <>;:% are
-    #   excluded. This value is specified at the time the user is created and
-    #   stored as an attribute of the user object in the identity store.
+    #   symbols, numbers, and punctuation. This value is specified at the time
+    #   the user is created and stored as an attribute of the user object in
+    #   the identity store.
     #
     # @option params [Types::Name] :name
     #   An object containing the user's name.
@@ -600,7 +600,7 @@ module Aws::IdentityStore
     #   The globally unique identifier for the identity store.
     #
     # @option params [required, String] :membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a `GroupMembership` in an identity store.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -693,14 +693,14 @@ module Aws::IdentityStore
       req.send_request(options)
     end
 
-    # Retrieves membership metadata and attributes from `MembershipId` in a
-    # group.
+    # Retrieves membership metadata and attributes from `MembershipId` in an
+    # identity store.
     #
     # @option params [required, String] :identity_store_id
     #   The globally unique identifier for the identity store.
     #
     # @option params [required, String] :membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a `GroupMembership` in an identity store.
     #
     # @return [Types::DescribeGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -826,9 +826,9 @@ module Aws::IdentityStore
     #   The globally unique identifier for the identity store.
     #
     # @option params [required, Types::AlternateIdentifier] :alternate_identifier
-    #   A unique identifier for the group value that is not the group's
-    #   primary identifier. This value can be an identifier from an external
-    #   identity provider (IdP) that is associated with the group or a unique
+    #   A unique identifier for an identity resource that is not the primary
+    #   identifier. This value can be an identifier from an external identity
+    #   provider (IdP) that is associated with the group or a unique
     #   attribute. For example, a unique `GroupDisplayName`.
     #
     # @return [Types::GetGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -866,7 +866,7 @@ module Aws::IdentityStore
       req.send_request(options)
     end
 
-    # Retrieves the `MembershipId` in a group.
+    # Retrieves the `MembershipId` in an identity store.
     #
     # @option params [required, String] :identity_store_id
     #   The globally unique identifier for the identity store.
@@ -914,7 +914,8 @@ module Aws::IdentityStore
     #   The globally unique identifier for the identity store.
     #
     # @option params [required, Types::AlternateIdentifier] :alternate_identifier
-    #   Any unique attribute associated with a user that is not the `UserId`.
+    #   A unique identifier for an identity resource that is not the primary
+    #   identifier.
     #
     # @return [Types::GetUserIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -951,7 +952,8 @@ module Aws::IdentityStore
       req.send_request(options)
     end
 
-    # Returns if a member exists in specified groups.
+    # Checks the user's membership in all requested groups and returns if
+    # the member exists in all queried groups.
     #
     # @option params [required, String] :identity_store_id
     #   The globally unique identifier for the identity store.
@@ -1004,9 +1006,8 @@ module Aws::IdentityStore
     #
     # @option params [Integer] :max_results
     #   The maximum number of results to be returned per request. This
-    #   parameter is used in the `ListUsers` and `ListGroups` requests to
-    #   specify how many results to return in one page. The length limit is 50
-    #   characters.
+    #   parameter is used in all `List` requests to specify how many results
+    #   to return in one page.
     #
     # @option params [String] :next_token
     #   The pagination token used for the `ListUsers`, `ListGroups` and
@@ -1069,7 +1070,7 @@ module Aws::IdentityStore
     #   characters.
     #
     # @option params [String] :next_token
-    #   The pagination token used for the `ListUsers`, `ListGroups` and
+    #   The pagination token used for the `ListUsers`, `ListGroups`, and
     #   `ListGroupMemberships` API operations. This value is generated by the
     #   identity store service. It is returned in the API response if the
     #   total results are more than the size of one page. This token is also
@@ -1112,11 +1113,11 @@ module Aws::IdentityStore
       req.send_request(options)
     end
 
-    # *Filtering for a group by the group `DisplayName` attribute is
-    # deprecated. Instead, use the `GetGroupId` API action.*
-    #
-    # Lists all groups in the identity store. Returns a paginated list of
-    # complete `Group` objects.
+    # Lists the attribute name and value of the group that you specified in
+    # the search. We only support `DisplayName` as a valid filter attribute
+    # path currently, and filter is required. This API returns minimum
+    # attributes, including `GroupId` and group `DisplayName` in the
+    # response.
     #
     # @option params [required, String] :identity_store_id
     #   The globally unique identifier for the identity store, such as
@@ -1139,7 +1140,7 @@ module Aws::IdentityStore
     #   API request to search for the next page.
     #
     # @option params [Array<Types::Filter>] :filters
-    #   A list of `Filter` objects that is used in the `ListUsers` and
+    #   A list of `Filter` objects, which is used in the `ListUsers` and
     #   `ListGroups` requests.
     #
     # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1184,11 +1185,10 @@ module Aws::IdentityStore
       req.send_request(options)
     end
 
-    # *Filtering for a user by the `UserName` attribute is deprecated.
-    # Instead, use the `GetUserId` API action.*
-    #
-    # Lists all users in the identity store. Returns a paginated list of
-    # complete `User` objects.
+    # Lists the attribute name and value of the user that you specified in
+    # the search. We only support `UserName` as a valid filter attribute
+    # path currently, and filter is required. This API returns minimum
+    # attributes, including `UserId` and `UserName` in the response.
     #
     # @option params [required, String] :identity_store_id
     #   The globally unique identifier for the identity store, such as
@@ -1211,7 +1211,7 @@ module Aws::IdentityStore
     #   API request to search for the next page.
     #
     # @option params [Array<Types::Filter>] :filters
-    #   A list of `Filter` objects that is used in the `ListUsers` and
+    #   A list of `Filter` objects, which is used in the `ListUsers` and
     #   `ListGroups` requests.
     #
     # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1373,7 +1373,7 @@ module Aws::IdentityStore
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-identitystore'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.20.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -76,8 +76,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] primary
-    #   A boolean representing whether this is the primary address for the
-    #   associated resource.
+    #   A Boolean value representing whether this is the primary address for
+    #   the associated resource.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Address AWS API Documentation
@@ -95,9 +95,9 @@ module Aws::IdentityStore
       include Aws::Structure
     end
 
-    # A unique identifier for the group value that is not the group's
-    # primary identifier. This value can be an identifier from an external
-    # identity provider (IdP) that is associated with the group or a unique
+    # A unique identifier for a user or group that is not the its primary
+    # identifier. This value can be an identifier from an external identity
+    # provider (IdP) that is associated with the group or a unique
     # attribute. For example, a unique `GroupDisplayName`.
     #
     # @note AlternateIdentifier is a union - when making an API calls you must set exactly one of the members.
@@ -143,7 +143,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] attribute_value
-    #   The value of the attribute.
+    #   The value of the attribute. This is a `Document` type. This type is
+    #   not supported by Java V1, Go V1, and older versions of the AWS CLI.
     #   @return [Hash,Array,String,Numeric,Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/AttributeOperation AWS API Documentation
@@ -231,7 +232,8 @@ module Aws::IdentityStore
     end
 
     # @!attribute [rw] membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a newly created `GroupMembership` in an identity
+    #   store.
     #   @return [String]
     #
     # @!attribute [rw] identity_store_id
@@ -353,9 +355,9 @@ module Aws::IdentityStore
     # @!attribute [rw] user_name
     #   A unique string used to identify the user. The length limit is 128
     #   characters. This value can consist of letters, accented characters,
-    #   symbols, numbers, and punctuation. The characters <>;:% are
-    #   excluded. This value is specified at the time the user is created
-    #   and stored as an attribute of the user object in the identity store.
+    #   symbols, numbers, and punctuation. This value is specified at the
+    #   time the user is created and stored as an attribute of the user
+    #   object in the identity store.
     #   @return [String]
     #
     # @!attribute [rw] name
@@ -466,7 +468,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a `GroupMembership` in an identity store.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembershipRequest AWS API Documentation
@@ -553,7 +555,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a `GroupMembership` in an identity store.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembershipRequest AWS API Documentation
@@ -570,7 +572,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a `GroupMembership` in an identity store.
     #   @return [String]
     #
     # @!attribute [rw] group_id
@@ -690,11 +692,11 @@ module Aws::IdentityStore
     end
 
     # @!attribute [rw] user_name
-    #   The user’s username value. The length limit is 128 characters. This
-    #   value can consist of letters, accented characters, symbols, numbers,
-    #   and punctuation. The characters `<>;:%` are excluded. This value is
-    #   specified at the time the user is created and stored as an attribute
-    #   of the user object in the identity store.
+    #   A unique string used to identify the user. The length limit is 128
+    #   characters. This value can consist of letters, accented characters,
+    #   symbols, numbers, and punctuation. This value is specified at the
+    #   time the user is created and stored as an attribute of the user
+    #   object in the identity store.
     #   @return [String]
     #
     # @!attribute [rw] user_id
@@ -802,8 +804,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] primary
-    #   A boolean representing whether this is the primary email for the
-    #   associated resource.
+    #   A Boolean value representing whether this is the primary email
+    #   address for the associated resource.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Email AWS API Documentation
@@ -900,8 +902,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] alternate_identifier
-    #   A unique identifier for the group value that is not the group's
-    #   primary identifier. This value can be an identifier from an external
+    #   A unique identifier for an identity resource that is not the primary
+    #   identifier. This value can be an identifier from an external
     #   identity provider (IdP) that is associated with the group or a
     #   unique attribute. For example, a unique `GroupDisplayName`.
     #   @return [Types::AlternateIdentifier]
@@ -968,7 +970,7 @@ module Aws::IdentityStore
     end
 
     # @!attribute [rw] membership_id
-    #   The identifier for a `GroupMembership` in the identity store.
+    #   The identifier for a `GroupMembership` in an identity store.
     #   @return [String]
     #
     # @!attribute [rw] identity_store_id
@@ -1006,8 +1008,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] alternate_identifier
-    #   Any unique attribute associated with a user that is not the
-    #   `UserId`.
+    #   A unique identifier for an identity resource that is not the primary
+    #   identifier.
     #   @return [Types::AlternateIdentifier]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdRequest AWS API Documentation
@@ -1086,7 +1088,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] membership_id
-    #   The identifier for a `GroupMembership` object in the identity store.
+    #   The identifier for a `GroupMembership` object in an identity store.
     #   @return [String]
     #
     # @!attribute [rw] group_id
@@ -1199,7 +1201,7 @@ module Aws::IdentityStore
     end
 
     # @!attribute [rw] results
-    #   An object containing results of batch `IsMemberInGroups` call.
+    #   A list containing the results of membership existence checks.
     #   @return [Array<Types::GroupMembershipExistenceResult>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroupsResponse AWS API Documentation
@@ -1240,7 +1242,7 @@ module Aws::IdentityStore
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
-    #   The pagination token used for the `ListUsers`, `ListGroups` and
+    #   The pagination token used for the `ListUsers`, `ListGroups`, and
     #   `ListGroupMemberships` API operations. This value is generated by
     #   the identity store service. It is returned in the API response if
     #   the total results are more than the size of one page. This token is
@@ -1265,7 +1267,7 @@ module Aws::IdentityStore
     #   @return [Array<Types::GroupMembership>]
     #
     # @!attribute [rw] next_token
-    #   The pagination token used for the `ListUsers`, `ListGroups` and
+    #   The pagination token used for the `ListUsers`, `ListGroups`, and
     #   `ListGroupMemberships` API operations. This value is generated by
     #   the identity store service. It is returned in the API response if
     #   the total results are more than the size of one page. This token is
@@ -1302,9 +1304,8 @@ module Aws::IdentityStore
     #
     # @!attribute [rw] max_results
     #   The maximum number of results to be returned per request. This
-    #   parameter is used in the `ListUsers` and `ListGroups` requests to
-    #   specify how many results to return in one page. The length limit is
-    #   50 characters.
+    #   parameter is used in all `List` requests to specify how many results
+    #   to return in one page.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -1332,7 +1333,7 @@ module Aws::IdentityStore
     #   @return [Array<Types::GroupMembership>]
     #
     # @!attribute [rw] next_token
-    #   The pagination token used for the `ListUsers`, `ListGroups` and
+    #   The pagination token used for the `ListUsers`, `ListGroups`, and
     #   `ListGroupMemberships` API operations. This value is generated by
     #   the identity store service. It is returned in the API response if
     #   the total results are more than the size of one page. This token is
@@ -1388,7 +1389,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] filters
-    #   A list of `Filter` objects that is used in the `ListUsers` and
+    #   A list of `Filter` objects, which is used in the `ListUsers` and
     #   `ListGroups` requests.
     #   @return [Array<Types::Filter>]
     #
@@ -1463,7 +1464,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] filters
-    #   A list of `Filter` objects that is used in the `ListUsers` and
+    #   A list of `Filter` objects, which is used in the `ListUsers` and
     #   `ListGroups` requests.
     #   @return [Array<Types::Filter>]
     #
@@ -1523,7 +1524,7 @@ module Aws::IdentityStore
       class Unknown < MemberId; end
     end
 
-    # The name of the user.
+    # The full name of the user.
     #
     # @note When making an API call, you may pass Name
     #   data as a hash:
@@ -1596,8 +1597,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] primary
-    #   A boolean representing whether this is the primary phone number for
-    #   the associated resource.
+    #   A Boolean value representing whether this is the primary phone
+    #   number for the associated resource.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/PhoneNumber AWS API Documentation
@@ -1715,7 +1716,8 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] attribute_value
-    #   The value of the attribute.
+    #   The value of the attribute. This is a `Document` type. This type is
+    #   not supported by Java V1, Go V1, and older versions of the AWS CLI.
     #   @return [Hash,Array,String,Numeric,Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UniqueAttribute AWS API Documentation
@@ -1813,11 +1815,11 @@ module Aws::IdentityStore
     # attributes.
     #
     # @!attribute [rw] user_name
-    #   The user’s user name value. The length limit is 128 characters. This
-    #   value can consist of letters, accented characters, symbols, numbers,
-    #   and punctuation. The characters `<>;:%` are excluded. This value is
-    #   specified at the time the user is created and stored as an attribute
-    #   of the user object in the identity store.
+    #   A unique string used to identify the user. The length limit is 128
+    #   characters. This value can consist of letters, accented characters,
+    #   symbols, numbers, and punctuation. This value is specified at the
+    #   time the user is created and stored as an attribute of the user
+    #   object in the identity store.
     #   @return [String]
     #
     # @!attribute [rw] user_id
@@ -1868,7 +1870,7 @@ module Aws::IdentityStore
     #
     # @!attribute [rw] title
     #   A string containing the user's title. Possible values depend on
-    #   each customer's specific needs, so they are left unspecified
+    #   each customer's specific needs, so they are left unspecified.
     #   @return [String]
     #
     # @!attribute [rw] preferred_language

data/lib/aws-sdk-identitystore.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-identitystore/customizations'
 # @!group service
 module Aws::IdentityStore
 
-  GEM_VERSION = '1.19.0'
+  GEM_VERSION = '1.20.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-identitystore
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core