lib/aws-sdk-iam/client.rb in aws-sdk-iam-1.81.0 vs lib/aws-sdk-iam/client.rb in aws-sdk-iam-1.82.0

- old
+ new

@@ -551,22 +551,23 @@ end # Attaches the specified managed policy to the specified IAM group. # # You use this operation to attach a managed policy to a group. To embed - # an inline policy in a group, use PutGroupPolicy. + # an inline policy in a group, use [ `PutGroupPolicy` ][1]. # # As a best practice, you can validate your IAM policies. To learn more, - # see [Validating IAM policies][1] in the *IAM User Guide*. + # see [Validating IAM policies][2] in the *IAM User Guide*. # # For more information about policies, see [Managed policies and inline - # policies][2] in the *IAM User Guide*. + # policies][3] in the *IAM User Guide*. # # # - # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html - # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html + # [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutGroupPolicy.html + # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html + # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html # # @option params [required, String] :group_name # The name (friendly name, not ARN) of the group to attach the policy # to. # @@ -620,28 +621,31 @@ # Attaches the specified managed policy to the specified IAM role. When # you attach a managed policy to a role, the managed policy becomes part # of the role's permission (access) policy. # # <note markdown="1"> You cannot use a managed policy as the role's trust policy. The - # role's trust policy is created at the same time as the role, using - # CreateRole. You can update a role's trust policy using - # UpdateAssumeRolePolicy. + # role's trust policy is created at the same time as the role, using [ + # `CreateRole` ][1]. You can update a role's trust policy using [ + # `UpdateAssumerolePolicy` ][2]. # # </note> # # Use this operation to attach a *managed* policy to a role. To embed an - # inline policy in a role, use PutRolePolicy. For more information about - # policies, see [Managed policies and inline policies][1] in the *IAM - # User Guide*. + # inline policy in a role, use [ `PutRolePolicy` ][3]. For more + # information about policies, see [Managed policies and inline + # policies][4] in the *IAM User Guide*. # # As a best practice, you can validate your IAM policies. To learn more, - # see [Validating IAM policies][2] in the *IAM User Guide*. + # see [Validating IAM policies][5] in the *IAM User Guide*. # # # - # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html - # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html + # [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html + # [2]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html + # [3]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutRolePolicy.html + # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html + # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html # # @option params [required, String] :role_name # The name (friendly name, not ARN) of the role to attach the policy to. # # This parameter allows (through its [regex pattern][1]) a string of @@ -692,22 +696,23 @@ end # Attaches the specified managed policy to the specified user. # # You use this operation to attach a *managed* policy to a user. To - # embed an inline policy in a user, use PutUserPolicy. + # embed an inline policy in a user, use [ `PutUserPolicy` ][1]. # # As a best practice, you can validate your IAM policies. To learn more, - # see [Validating IAM policies][1] in the *IAM User Guide*. + # see [Validating IAM policies][2] in the *IAM User Guide*. # # For more information about policies, see [Managed policies and inline - # policies][2] in the *IAM User Guide*. + # policies][3] in the *IAM User Guide*. # # # - # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html - # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html + # [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutUserPolicy.html + # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html + # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html # # @option params [required, String] :user_name # The name (friendly name, not ARN) of the IAM user to attach the policy # to. # @@ -5031,10 +5036,54 @@ def get_login_profile(params = {}, options = {}) req = build_request(:get_login_profile, params) req.send_request(options) end + # Retrieves information about an MFA device for a specified user. + # + # @option params [required, String] :serial_number + # Serial number that uniquely identifies the MFA device. For this API, + # we only accept FIDO security key [ARNs][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html + # + # @option params [String] :user_name + # The friendly name identifying the user. + # + # @return [Types::GetMFADeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetMFADeviceResponse#user_name #user_name} => String + # * {Types::GetMFADeviceResponse#serial_number #serial_number} => String + # * {Types::GetMFADeviceResponse#enable_date #enable_date} => Time + # * {Types::GetMFADeviceResponse#certifications #certifications} => Hash&lt;String,String&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.get_mfa_device({ + # serial_number: "serialNumberType", # required + # user_name: "userNameType", + # }) + # + # @example Response structure + # + # resp.user_name #=> String + # resp.serial_number #=> String + # resp.enable_date #=> Time + # resp.certifications #=> Hash + # resp.certifications["CertificationKeyType"] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/GetMFADevice AWS API Documentation + # + # @overload get_mfa_device(params = {}) + # @param [Hash] params ({}) + def get_mfa_device(params = {}, options = {}) + req = build_request(:get_mfa_device, params) + req.send_request(options) + end + # Returns information about the specified OpenID Connect (OIDC) provider # resource object in IAM. # # @option params [required, String] :open_id_connect_provider_arn # The Amazon Resource Name (ARN) of the OIDC provider resource object in @@ -7189,10 +7238,12 @@ # # * {Types::ListInstanceProfileTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListInstanceProfileTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListInstanceProfileTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_instance_profile_tags({ # instance_profile_name: "instanceProfileNameType", # required # marker: "markerType", @@ -7465,10 +7516,12 @@ # # * {Types::ListMFADeviceTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListMFADeviceTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListMFADeviceTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_mfa_device_tags({ # serial_number: "serialNumberType", # required # marker: "markerType", @@ -7611,10 +7664,12 @@ # # * {Types::ListOpenIDConnectProviderTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListOpenIDConnectProviderTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListOpenIDConnectProviderTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_open_id_connect_provider_tags({ # open_id_connect_provider_arn: "arnType", # required # marker: "markerType", @@ -7997,10 +8052,12 @@ # # * {Types::ListPolicyTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListPolicyTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListPolicyTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_policy_tags({ # policy_arn: "arnType", # required # marker: "markerType", @@ -8216,11 +8273,13 @@ # # * {Types::ListRoleTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListRoleTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListRoleTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list the tags attached to an IAM role # # # The following example shows how to list the tags attached to a role. # # resp = client.list_role_tags({ @@ -8420,10 +8479,12 @@ # # * {Types::ListSAMLProviderTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListSAMLProviderTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListSAMLProviderTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_saml_provider_tags({ # saml_provider_arn: "arnType", # required # marker: "markerType", @@ -8614,10 +8675,12 @@ # # * {Types::ListServerCertificateTagsResponse#tags #tags} => Array&lt;Types::Tag&gt; # * {Types::ListServerCertificateTagsResponse#is_truncated #is_truncated} => Boolean # * {Types::ListServerCertificateTagsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_server_certificate_tags({ # server_certificate_name: "serverCertificateNameType", # required # marker: "markerType", @@ -9307,30 +9370,33 @@ # Adds or updates an inline policy document that is embedded in the # specified IAM group. # # A user can also have managed policies attached to it. To attach a - # managed policy to a group, use AttachGroupPolicy. To create a new - # managed policy, use CreatePolicy. For information about policies, see - # [Managed policies and inline policies][1] in the *IAM User Guide*. + # managed policy to a group, use [ `AttachGroupPolicy` ][1]. To create a + # new managed policy, use [ `CreatePolicy` ][2]. For information about + # policies, see [Managed policies and inline policies][3] in the *IAM + # User Guide*. # # For information about the maximum number of inline policies that you - # can embed in a group, see [IAM and STS quotas][2] in the *IAM User + # can embed in a group, see [IAM and STS quotas][4] in the *IAM User # Guide*. # # <note markdown="1"> Because policy documents can be large, you should use POST rather than # GET when calling `PutGroupPolicy`. For general information about using - # the Query API with IAM, see [Making query requests][3] in the *IAM + # the Query API with IAM, see [Making query requests][5] in the *IAM # User Guide*. # # </note> # # # - # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html - # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html - # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html + # [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachGroupPolicy.html + # [2]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html + # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html + # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html + # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html # # @option params [required, String] :group_name # The name of the group to associate the policy with. # # This parameter allows (through its [regex pattern][1]) a string of @@ -9470,37 +9536,42 @@ # Adds or updates an inline policy document that is embedded in the # specified IAM role. # # When you embed an inline policy in a role, the inline policy is used # as part of the role's access (permissions) policy. The role's trust - # policy is created at the same time as the role, using CreateRole. You - # can update a role's trust policy using UpdateAssumeRolePolicy. For - # more information about IAM roles, see [Using roles to delegate - # permissions and federate identities][1]. + # policy is created at the same time as the role, using [ `CreateRole` + # ][1]. You can update a role's trust policy using [ + # `UpdateAssumerolePolicy` ][2]. For more information about IAM roles, + # see [Using roles to delegate permissions and federate identities][3]. # # A role can also have a managed policy attached to it. To attach a - # managed policy to a role, use AttachRolePolicy. To create a new - # managed policy, use CreatePolicy. For information about policies, see - # [Managed policies and inline policies][2] in the *IAM User Guide*. + # managed policy to a role, use [ `AttachRolePolicy` ][4]. To create a + # new managed policy, use [ `CreatePolicy` ][5]. For information about + # policies, see [Managed policies and inline policies][6] in the *IAM + # User Guide*. # # For information about the maximum number of inline policies that you - # can embed with a role, see [IAM and STS quotas][3] in the *IAM User + # can embed with a role, see [IAM and STS quotas][7] in the *IAM User # Guide*. # # <note markdown="1"> Because policy documents can be large, you should use POST rather than # GET when calling `PutRolePolicy`. For general information about using - # the Query API with IAM, see [Making query requests][4] in the *IAM + # the Query API with IAM, see [Making query requests][8] in the *IAM # User Guide*. # # </note> # # # - # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html - # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html - # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html - # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html + # [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html + # [2]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html + # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html + # [4]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachRolePolicy.html + # [5]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html + # [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html + # [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html + # [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html # # @option params [required, String] :role_name # The name of the role to associate the policy with. # # This parameter allows (through its [regex pattern][1]) a string of @@ -9637,30 +9708,33 @@ # Adds or updates an inline policy document that is embedded in the # specified IAM user. # # An IAM user can also have a managed policy attached to it. To attach a - # managed policy to a user, use AttachUserPolicy. To create a new - # managed policy, use CreatePolicy. For information about policies, see - # [Managed policies and inline policies][1] in the *IAM User Guide*. + # managed policy to a user, use [ `AttachUserPolicy` ][1]. To create a + # new managed policy, use [ `CreatePolicy` ][2]. For information about + # policies, see [Managed policies and inline policies][3] in the *IAM + # User Guide*. # # For information about the maximum number of inline policies that you - # can embed in a user, see [IAM and STS quotas][2] in the *IAM User + # can embed in a user, see [IAM and STS quotas][4] in the *IAM User # Guide*. # # <note markdown="1"> Because policy documents can be large, you should use POST rather than # GET when calling `PutUserPolicy`. For general information about using - # the Query API with IAM, see [Making query requests][3] in the *IAM + # the Query API with IAM, see [Making query requests][5] in the *IAM # User Guide*. # # </note> # # # - # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html - # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html - # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html + # [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachUserPolicy.html + # [2]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html + # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html + # [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html + # [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html # # @option params [required, String] :user_name # The name of the user to associate the policy with. # # This parameter allows (through its [regex pattern][1]) a string of @@ -13367,10 +13441,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-iam' - context[:gem_version] = '1.81.0' + context[:gem_version] = '1.82.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #