aws-sdk-identitystore 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15294df7a15cd0b04e3649d9ad32a6c24de545de10b954665813f22534bc628e
-  data.tar.gz: 57e3f977d450491a4c7ec8b240d419b6495c3f669a52f5162df9f217a71d8af9
+  metadata.gz: 3675a6bdceda583b06cdb53529dbbef39df89dfbfd812086da3d7e0268ce22a1
+  data.tar.gz: ab90b48019d6b26960538069a2e8baf79ac04e4d8427ad06dac06dbedfe6100e
 SHA512:
-  metadata.gz: 01fae7624aba8723045fdb63ebc0327ecc48129cb1556602e98037e1638b6467ab1043b49bab10d5427398931e6e9697dc245b890847ccbca15d24f69a637414
-  data.tar.gz: b9021d2deb0a94397dd1aec2f52a226fbbb6d25ef857eb623e9f5f749b6b97d753fe92492dd4b6ceecad84ad0049416c40c08d71ecd90643655282ad4fb44893
+  metadata.gz: 3edf748033e912b75d27b8c41564df1bbd51dec98628a17dae6feee4595e4fb6594c5cc4d0dc97c3cb5bdf7b9014eb898d1675a0deaa5359a1ff11acce53a1b5
+  data.tar.gz: 3d5b701207b9d5877fc501c8301dad8fdc3f5f30381d969a4f4579ce85e3ac943fd5f38c1fabec65955463e1d092b7a4f61fddc8202941980c55ad57a67b1f95

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.24.0 (2023-04-05)
+------------------
+
+* Feature - Documentation updates for Identity Store CLI command reference.
+
 1.23.0 (2023-01-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.23.0
+1.24.0

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

@@ -385,7 +385,9 @@ module Aws::IdentityStore
     #
     # @option params [String] :display_name
     #   A string containing the name of the group. This value is commonly
-    #   displayed when the group is referenced.
+    #   displayed when the group is referenced. "Administrator" and
+    #   "AWSAdministrators" are reserved names and can't be used for users
+    #   or groups.
     #
     # @option params [String] :description
     #   A string containing the description of the group.
@@ -461,7 +463,7 @@ module Aws::IdentityStore
       req.send_request(options)
     end
 
-    # Creates a new user within the specified identity store.
+    # Creates a user within the specified identity store.
     #
     # @option params [required, String] :identity_store_id
     #   The globally unique identifier for the identity store.
@@ -471,13 +473,14 @@ module Aws::IdentityStore
     #   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.
+    #   the identity store. "Administrator" and "AWSAdministrators" are
+    #   reserved names and can't be used for users or groups.
     #
     # @option params [Types::Name] :name
-    #   An object containing the user's name.
+    #   An object containing the name of the user.
     #
     # @option params [String] :display_name
-    #   A string containing the user's name. This value is typically
+    #   A string containing the name of the user. This value is typically
     #   formatted for display when the user is referenced. For example, "John
     #   Doe."
     #
@@ -485,7 +488,7 @@ module Aws::IdentityStore
     #   A string containing an alternate name for the user.
     #
     # @option params [String] :profile_url
-    #   A string containing a URL that may be associated with the user.
+    #   A string containing a URL that might be associated with the user.
     #
     # @option params [Array<Types::Email>] :emails
     #   A list of `Email` objects containing email addresses associated with
@@ -500,22 +503,22 @@ module Aws::IdentityStore
     #   with the user.
     #
     # @option params [String] :user_type
-    #   A string indicating the user's type. Possible values depend on each
-    #   customer's specific needs, so they are left unspecified.
+    #   A string indicating the type of user. Possible values are left
+    #   unspecified. The value can vary based on your specific use case.
     #
     # @option params [String] :title
-    #   A string containing the user's title. Possible values are left
-    #   unspecified given that they depend on each customer's specific needs.
+    #   A string containing the title of the user. Possible values are left
+    #   unspecified. The value can vary based on your specific use case.
     #
     # @option params [String] :preferred_language
     #   A string containing the preferred language of the user. For example,
     #   "American English" or "en-us."
     #
     # @option params [String] :locale
-    #   A string containing the user's geographical region or location.
+    #   A string containing the geographical region or location of the user.
     #
     # @option params [String] :timezone
-    #   A string containing the user's time zone.
+    #   A string containing the time zone of the user.
     #
     # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -846,7 +849,8 @@ module Aws::IdentityStore
     #   A unique identifier for a user or group that is not the primary
     #   identifier. This value can be an identifier from an external identity
     #   provider (IdP) that is associated with the user, the group, or a
-    #   unique attribute. For example, a unique `GroupDisplayName`.
+    #   unique attribute. For the unique attribute, the only valid path is
+    #   `displayName`.
     #
     # @return [Types::GetGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -934,7 +938,8 @@ module Aws::IdentityStore
     #   A unique identifier for a user or group that is not the primary
     #   identifier. This value can be an identifier from an external identity
     #   provider (IdP) that is associated with the user, the group, or a
-    #   unique attribute. For example, a unique `UserDisplayName`.
+    #   unique attribute. For the unique attribute, the only valid paths are
+    #   `userName` and `emails.value`.
     #
     # @return [Types::GetUserIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1389,7 +1394,7 @@ module Aws::IdentityStore
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-identitystore'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -14,39 +14,42 @@ module Aws::IdentityStore
       use_dual_stack = parameters.use_dual_stack
       use_fips = parameters.use_fips
       endpoint = parameters.endpoint
-      if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
-        if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
-          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
-          end
-          if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-            raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
-          end
-          return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
+      if Aws::Endpoints::Matchers.set?(endpoint)
+        if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+          raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
         end
-        if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
-            return Aws::Endpoints::Endpoint.new(url: "https://identitystore-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
-          end
-          raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
+        if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+          raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
         end
-        if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
-            if Aws::Endpoints::Matchers.string_equals?("aws-us-gov", Aws::Endpoints::Matchers.attr(partition_result, "name"))
-              return Aws::Endpoints::Endpoint.new(url: "https://identitystore.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+        return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
+      end
+      if Aws::Endpoints::Matchers.set?(region)
+        if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
+          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+              return Aws::Endpoints::Endpoint.new(url: "https://identitystore-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
             end
-            return Aws::Endpoints::Endpoint.new(url: "https://identitystore-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+            raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
-          raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
-        end
-        if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
-            return Aws::Endpoints::Endpoint.new(url: "https://identitystore.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+              if Aws::Endpoints::Matchers.string_equals?("aws-us-gov", Aws::Endpoints::Matchers.attr(partition_result, "name"))
+                return Aws::Endpoints::Endpoint.new(url: "https://identitystore.#{region}.amazonaws.com", headers: {}, properties: {})
+              end
+              return Aws::Endpoints::Endpoint.new(url: "https://identitystore-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+          end
+          if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+              return Aws::Endpoints::Endpoint.new(url: "https://identitystore.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
           end
-          raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
+          return Aws::Endpoints::Endpoint.new(url: "https://identitystore.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
         end
-        return Aws::Endpoints::Endpoint.new(url: "https://identitystore.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
       end
+      raise ArgumentError, "Invalid Configuration: Missing Region"
       raise ArgumentError, 'No endpoint could be resolved'
 
     end

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

@@ -84,7 +84,7 @@ module Aws::IdentityStore
     # A unique identifier for a user or group that is not the primary
     # identifier. This value can be an identifier from an external identity
     # provider (IdP) that is associated with the user, the group, or a
-    # unique attribute. For example, a unique `GroupDisplayName`.
+    # unique attribute.
     #
     # @note AlternateIdentifier is a union - when making an API calls you must set exactly one of the members.
     #
@@ -222,7 +222,9 @@ module Aws::IdentityStore
     #
     # @!attribute [rw] display_name
     #   A string containing the name of the group. This value is commonly
-    #   displayed when the group is referenced.
+    #   displayed when the group is referenced. "Administrator" and
+    #   "AWSAdministrators" are reserved names and can't be used for
+    #   users or groups.
     #   @return [String]
     #
     # @!attribute [rw] description
@@ -265,15 +267,17 @@ module Aws::IdentityStore
     #   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.
+    #   object in the identity store. "Administrator" and
+    #   "AWSAdministrators" are reserved names and can't be used for
+    #   users or groups.
     #   @return [String]
     #
     # @!attribute [rw] name
-    #   An object containing the user's name.
+    #   An object containing the name of the user.
     #   @return [Types::Name]
     #
     # @!attribute [rw] display_name
-    #   A string containing the user's name. This value is typically
+    #   A string containing the name of the user. This value is typically
     #   formatted for display when the user is referenced. For example,
     #   "John Doe."
     #   @return [String]
@@ -283,7 +287,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] profile_url
-    #   A string containing a URL that may be associated with the user.
+    #   A string containing a URL that might be associated with the user.
     #   @return [String]
     #
     # @!attribute [rw] emails
@@ -302,14 +306,13 @@ module Aws::IdentityStore
     #   @return [Array<Types::PhoneNumber>]
     #
     # @!attribute [rw] user_type
-    #   A string indicating the user's type. Possible values depend on each
-    #   customer's specific needs, so they are left unspecified.
+    #   A string indicating the type of user. Possible values are left
+    #   unspecified. The value can vary based on your specific use case.
     #   @return [String]
     #
     # @!attribute [rw] title
-    #   A string containing the user's title. Possible values are left
-    #   unspecified given that they depend on each customer's specific
-    #   needs.
+    #   A string containing the title of the user. Possible values are left
+    #   unspecified. The value can vary based on your specific use case.
     #   @return [String]
     #
     # @!attribute [rw] preferred_language
@@ -318,11 +321,11 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] locale
-    #   A string containing the user's geographical region or location.
+    #   A string containing the geographical region or location of the user.
     #   @return [String]
     #
     # @!attribute [rw] timezone
-    #   A string containing the user's time zone.
+    #   A string containing the time zone of the user.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUserRequest AWS API Documentation
@@ -572,7 +575,7 @@ module Aws::IdentityStore
     #   @return [Types::Name]
     #
     # @!attribute [rw] display_name
-    #   The user's name value for display.
+    #   The display name of the user.
     #   @return [String]
     #
     # @!attribute [rw] nick_name
@@ -584,11 +587,11 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] emails
-    #   The user's email value.
+    #   The email address of the user.
     #   @return [Array<Types::Email>]
     #
     # @!attribute [rw] addresses
-    #   The user's physical address.
+    #   The physical address of the user.
     #   @return [Array<Types::Address>]
     #
     # @!attribute [rw] phone_numbers
@@ -596,11 +599,11 @@ module Aws::IdentityStore
     #   @return [Array<Types::PhoneNumber>]
     #
     # @!attribute [rw] user_type
-    #   A string indicating the user's type.
+    #   A string indicating the type of user.
     #   @return [String]
     #
     # @!attribute [rw] title
-    #   A string containing the user's title.
+    #   A string containing the title of the user.
     #   @return [String]
     #
     # @!attribute [rw] preferred_language
@@ -608,7 +611,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] locale
-    #   A string containing the user's geographical region or location.
+    #   A string containing the geographical region or location of the user.
     #   @return [String]
     #
     # @!attribute [rw] timezone
@@ -722,7 +725,8 @@ module Aws::IdentityStore
     #   A unique identifier for a user or group that is not the primary
     #   identifier. This value can be an identifier from an external
     #   identity provider (IdP) that is associated with the user, the group,
-    #   or a unique attribute. For example, a unique `GroupDisplayName`.
+    #   or a unique attribute. For the unique attribute, the only valid path
+    #   is `displayName`.
     #   @return [Types::AlternateIdentifier]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupIdRequest AWS API Documentation
@@ -800,7 +804,8 @@ module Aws::IdentityStore
     #   A unique identifier for a user or group that is not the primary
     #   identifier. This value can be an identifier from an external
     #   identity provider (IdP) that is associated with the user, the group,
-    #   or a unique attribute. For example, a unique `UserDisplayName`.
+    #   or a unique attribute. For the unique attribute, the only valid
+    #   paths are `userName` and `emails.value`.
     #   @return [Types::AlternateIdentifier]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdRequest AWS API Documentation
@@ -829,15 +834,15 @@ module Aws::IdentityStore
       include Aws::Structure
     end
 
-    # A group object that contains a specified group’s metadata and
-    # attributes.
+    # A group object that contains the metadata and attributes for a
+    # specified group.
     #
     # @!attribute [rw] group_id
     #   The identifier for a group in the identity store.
     #   @return [String]
     #
     # @!attribute [rw] display_name
-    #   The group’s display name value. The length limit is 1,024
+    #   The display name value for the group. The length limit is 1,024
     #   characters. This value can consist of letters, accented characters,
     #   symbols, numbers, punctuation, tab, new line, carriage return,
     #   space, and nonbreaking space in this attribute. This value is
@@ -943,8 +948,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] retry_after_seconds
-    #   The number of seconds that you would like to wait before retrying
-    #   the next request.
+    #   The number of seconds to wait before retrying the next request.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/InternalServerException AWS API Documentation
@@ -1392,8 +1396,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] retry_after_seconds
-    #   The number of seconds that you would like to wait before retrying
-    #   the next request.
+    #   The number of seconds to wait before retrying the next request.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ThrottlingException AWS API Documentation
@@ -1481,8 +1484,8 @@ module Aws::IdentityStore
     #
     class UpdateUserResponse < Aws::EmptyStructure; end
 
-    # A user object that contains a specified user’s metadata and
-    # attributes.
+    # A user object that contains the metadata and attributes for a
+    # specified user.
     #
     # @!attribute [rw] user_name
     #   A unique string used to identify the user. The length limit is 128
@@ -1502,12 +1505,12 @@ module Aws::IdentityStore
     #   @return [Array<Types::ExternalId>]
     #
     # @!attribute [rw] name
-    #   An object containing the user's name.
+    #   An object containing the name of the user.
     #   @return [Types::Name]
     #
     # @!attribute [rw] display_name
-    #   A string containing the user's name that's formatted for display
-    #   when the user is referenced. For example, "John Doe."
+    #   A string containing the name of the user that is formatted for
+    #   display when the user is referenced. For example, "John Doe."
     #   @return [String]
     #
     # @!attribute [rw] nick_name
@@ -1515,7 +1518,7 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] profile_url
-    #   A string containing a URL that may be associated with the user.
+    #   A string containing a URL that might be associated with the user.
     #   @return [String]
     #
     # @!attribute [rw] emails
@@ -1534,13 +1537,13 @@ module Aws::IdentityStore
     #   @return [Array<Types::PhoneNumber>]
     #
     # @!attribute [rw] user_type
-    #   A string indicating the user's type. Possible values depend on each
-    #   customer's specific needs, so they are left unspecified.
+    #   A string indicating the type of user. Possible values are left
+    #   unspecified. The value can vary based on your specific use case.
     #   @return [String]
     #
     # @!attribute [rw] title
-    #   A string containing the user's title. Possible values depend on
-    #   each customer's specific needs, so they are left unspecified.
+    #   A string containing the title of the user. Possible values are left
+    #   unspecified. The value can vary based on your specific use case.
     #   @return [String]
     #
     # @!attribute [rw] preferred_language
@@ -1549,11 +1552,11 @@ module Aws::IdentityStore
     #   @return [String]
     #
     # @!attribute [rw] locale
-    #   A string containing the user's geographical region or location.
+    #   A string containing the geographical region or location of the user.
     #   @return [String]
     #
     # @!attribute [rw] timezone
-    #   A string containing the user's time zone.
+    #   A string containing the time zone of the user.
     #   @return [String]
     #
     # @!attribute [rw] identity_store_id

data/lib/aws-sdk-identitystore.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-identitystore/customizations'
 # @!group service
 module Aws::IdentityStore
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.24.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-identitystore
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core