GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::IAM (3)

.ds Aq ’

NAME

Paws::IAM - Perl Interface to AWS AWS Identity and Access Management

CONTENTS

SYNOPSIS



  use Paws;

  my $obj = Paws->service(IAM)->new;
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ V1, V2 ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => Val1 },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => Val1  }, { Att1 => Val2 } ],
  );



DESCRIPTION

AWS Identity and Access Management

AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

<B>Signing RequestsB>

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

<B>Additional ResourcesB>

For more information, see the following:
o AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.
o IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.
o AWS Security Token Service. This guide describes how to create and use temporary security credentials.
o Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.

METHODS

    AddClientIDToOpenIDConnectProvider(ClientID => Str, OpenIDConnectProviderArn => Str)

Each argument is described in detail in: Paws::IAM::AddClientIDToOpenIDConnectProvider

Returns: nothing

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider.

This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

    AddRoleToInstanceProfile(InstanceProfileName => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::AddRoleToInstanceProfile

Returns: nothing

Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

    AddUserToGroup(GroupName => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::AddUserToGroup

Returns: nothing

Adds the specified user to the specified group.

    AttachGroupPolicy(GroupName => Str, PolicyArn => Str)

Each argument is described in detail in: Paws::IAM::AttachGroupPolicy

Returns: nothing

Attaches the specified managed policy to the specified group.

You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    AttachRolePolicy(PolicyArn => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::AttachRolePolicy

Returns: nothing

Attaches the specified managed policy to the specified role.

When you attach a managed policy to a role, the managed policy is used as the role’s access (permissions) policy. 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.

Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    AttachUserPolicy(PolicyArn => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::AttachUserPolicy

Returns: nothing

Attaches the specified managed policy to the specified user.

You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.

For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    ChangePassword(NewPassword => Str, OldPassword => Str)

Each argument is described in detail in: Paws::IAM::ChangePassword

Returns: nothing

Changes the password of the IAM user who is calling this action. The root account password is not affected by this action.

To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the Using IAM guide.

    CreateAccessKey([UserName => Str])

Each argument is described in detail in: Paws::IAM::CreateAccessKey

Returns: a Paws::IAM::CreateAccessKeyResponse instance

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

For information about limits on the number of keys you can create, see Limitations on IAM Entities in the Using IAM guide.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

    CreateAccountAlias(AccountAlias => Str)

Each argument is described in detail in: Paws::IAM::CreateAccountAlias

Returns: nothing

Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.

    CreateGroup(GroupName => Str, [Path => Str])

Each argument is described in detail in: Paws::IAM::CreateGroup

Returns: a Paws::IAM::CreateGroupResponse instance

Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in the Using IAM guide.

    CreateInstanceProfile(InstanceProfileName => Str, [Path => Str])

Each argument is described in detail in: Paws::IAM::CreateInstanceProfile

Returns: a Paws::IAM::CreateInstanceProfileResponse instance

Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.

For information about the number of instance profiles you can create, see Limitations on IAM Entities in the Using IAM guide.

    CreateLoginProfile(Password => Str, UserName => Str, [PasswordResetRequired => Bool])

Each argument is described in detail in: Paws::IAM::CreateLoginProfile

Returns: a Paws::IAM::CreateLoginProfileResponse instance

Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide.

    CreateOpenIDConnectProvider(ThumbprintList => ArrayRef[Str], Url => Str, [ClientIDList => ArrayRef[Str]])

Each argument is described in detail in: Paws::IAM::CreateOpenIDConnectProvider

Returns: a Paws::IAM::CreateOpenIDConnectProviderResponse instance

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

The OIDC provider that you create with this operation can be used as a principal in a role’s trust policy to establish a trust relationship between AWS and the OIDC provider.

When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.

Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the CreateOpenIDConnectProvider action to highly-privileged users.

    CreatePolicy(PolicyDocument => Str, PolicyName => Str, [Description => Str, Path => Str])

Each argument is described in detail in: Paws::IAM::CreatePolicy

Returns: a Paws::IAM::CreatePolicyResponse instance

Creates a new managed policy for your AWS account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy’s default version. For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.

For more information about managed policies in general, refer to Managed Policies and Inline Policies in the Using IAM guide.

    CreatePolicyVersion(PolicyArn => Str, PolicyDocument => Str, [SetAsDefault => Bool])

Each argument is described in detail in: Paws::IAM::CreatePolicyVersion

Returns: a Paws::IAM::CreatePolicyVersionResponse instance

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy’s default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

    CreateRole(AssumeRolePolicyDocument => Str, RoleName => Str, [Path => Str])

Each argument is described in detail in: Paws::IAM::CreateRole

Returns: a Paws::IAM::CreateRoleResponse instance

Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the Using IAM guide.

The policy in the following example grants permission to an EC2 instance to assume the role.

    CreateSAMLProvider(Name => Str, SAMLMetadataDocument => Str)

Each argument is described in detail in: Paws::IAM::CreateSAMLProvider

Returns: a Paws::IAM::CreateSAMLProviderResponse instance

Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.

The SAML provider that you create with this operation can be used as a principal in a role’s trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization’s IdP.

This operation requires Signature Version 4.

For more information, see Giving Console Access Using SAML and Creating Temporary Security Credentials for SAML Federation in the Using Temporary Credentials guide.

    CreateUser(UserName => Str, [Path => Str])

Each argument is described in detail in: Paws::IAM::CreateUser

Returns: a Paws::IAM::CreateUserResponse instance

Creates a new user for your AWS account.

For information about limitations on the number of users you can create, see Limitations on IAM Entities in the Using IAM guide.

    CreateVirtualMFADevice(VirtualMFADeviceName => Str, [Path => Str])

Each argument is described in detail in: Paws::IAM::CreateVirtualMFADevice

Returns: a Paws::IAM::CreateVirtualMFADeviceResponse instance

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the Using IAM guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

    DeactivateMFADevice(SerialNumber => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::DeactivateMFADevice

Returns: nothing

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.

    DeleteAccessKey(AccessKeyId => Str, [UserName => Str])

Each argument is described in detail in: Paws::IAM::DeleteAccessKey

Returns: nothing

Deletes the access key associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

    DeleteAccountAlias(AccountAlias => Str)

Each argument is described in detail in: Paws::IAM::DeleteAccountAlias

Returns: nothing

Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.

    DeleteAccountPasswordPolicy( => )

Each argument is described in detail in: Paws::IAM::DeleteAccountPasswordPolicy

Returns: nothing

Deletes the password policy for the AWS account.

    DeleteGroup(GroupName => Str)

Each argument is described in detail in: Paws::IAM::DeleteGroup

Returns: nothing

Deletes the specified group. The group must not contain any users or have any attached policies.

    DeleteGroupPolicy(GroupName => Str, PolicyName => Str)

Each argument is described in detail in: Paws::IAM::DeleteGroupPolicy

Returns: nothing

Deletes the specified inline policy that is embedded in the specified group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    DeleteInstanceProfile(InstanceProfileName => Str)

Each argument is described in detail in: Paws::IAM::DeleteInstanceProfile

Returns: nothing

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, go to About Instance Profiles.

    DeleteLoginProfile(UserName => Str)

Each argument is described in detail in: Paws::IAM::DeleteLoginProfile

Returns: nothing

Deletes the password for the specified user, which terminates the user’s ability to access AWS services through the AWS Management Console.

Deleting a user’s password does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

    DeleteOpenIDConnectProvider(OpenIDConnectProviderArn => Str)

Each argument is described in detail in: Paws::IAM::DeleteOpenIDConnectProvider

Returns: nothing

Deletes an IAM OpenID Connect identity provider.

Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail.

This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted.

    DeletePolicy(PolicyArn => Str)

Each argument is described in detail in: Paws::IAM::DeletePolicy

Returns: nothing

Deletes the specified managed policy.

Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy’s versions. The following steps describe the process for deleting a managed policy:
1. Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy APIs. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
2. Delete all versions of the policy using DeletePolicyVersion. To list the policy’s versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy’s default version in the next step of the process.
3. Delete the policy (this automatically deletes the policy’s default version) using this API.
For information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    DeletePolicyVersion(PolicyArn => Str, VersionId => Str)

Each argument is described in detail in: Paws::IAM::DeletePolicyVersion

Returns: nothing

Deletes the specified version of the specified managed policy.

You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

For information about versions for managed policies, refer to Versioning for Managed Policies in the Using IAM guide.

    DeleteRole(RoleName => Str)

Each argument is described in detail in: Paws::IAM::DeleteRole

Returns: nothing

Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.

Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

    DeleteRolePolicy(PolicyName => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::DeleteRolePolicy

Returns: nothing

Deletes the specified inline policy that is embedded in the specified role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    DeleteSAMLProvider(SAMLProviderArn => Str)

Each argument is described in detail in: Paws::IAM::DeleteSAMLProvider

Returns: nothing

Deletes a SAML provider.

Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail.

This operation requires Signature Version 4.

    DeleteServerCertificate(ServerCertificateName => Str)

Each argument is described in detail in: Paws::IAM::DeleteServerCertificate

Returns: nothing

Deletes the specified server certificate.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn’t detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

    DeleteSigningCertificate(CertificateId => Str, [UserName => Str])

Each argument is described in detail in: Paws::IAM::DeleteSigningCertificate

Returns: nothing

Deletes the specified signing certificate associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

    DeleteSSHPublicKey(SSHPublicKeyId => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::DeleteSSHPublicKey

Returns: nothing

Deletes the specified SSH public key.

The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

    DeleteUser(UserName => Str)

Each argument is described in detail in: Paws::IAM::DeleteUser

Returns: nothing

Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.

    DeleteUserPolicy(PolicyName => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::DeleteUserPolicy

Returns: nothing

Deletes the specified inline policy that is embedded in the specified user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    DeleteVirtualMFADevice(SerialNumber => Str)

Each argument is described in detail in: Paws::IAM::DeleteVirtualMFADevice

Returns: nothing

Deletes a virtual MFA device.

You must deactivate a user’s virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

    DetachGroupPolicy(GroupName => Str, PolicyArn => Str)

Each argument is described in detail in: Paws::IAM::DetachGroupPolicy

Returns: nothing

Removes the specified managed policy from the specified group.

A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    DetachRolePolicy(PolicyArn => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::DetachRolePolicy

Returns: nothing

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    DetachUserPolicy(PolicyArn => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::DetachUserPolicy

Returns: nothing

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    EnableMFADevice(AuthenticationCode1 => Str, AuthenticationCode2 => Str, SerialNumber => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::EnableMFADevice

Returns: nothing

Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.

    GenerateCredentialReport( => )

Each argument is described in detail in: Paws::IAM::GenerateCredentialReport

Returns: a Paws::IAM::GenerateCredentialReportResponse instance

Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.

    GetAccessKeyLastUsed(AccessKeyId => Str)

Each argument is described in detail in: Paws::IAM::GetAccessKeyLastUsed

Returns: a Paws::IAM::GetAccessKeyLastUsedResponse instance

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.

    GetAccountAuthorizationDetails([Filter => ArrayRef[Str], Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::GetAccountAuthorizationDetails

Returns: a Paws::IAM::GetAccountAuthorizationDetailsResponse instance

Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

    GetAccountPasswordPolicy( => )

Each argument is described in detail in: Paws::IAM::GetAccountPasswordPolicy

Returns: a Paws::IAM::GetAccountPasswordPolicyResponse instance

Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.

    GetAccountSummary( => )

Each argument is described in detail in: Paws::IAM::GetAccountSummary

Returns: a Paws::IAM::GetAccountSummaryResponse instance

Retrieves information about IAM entity usage and IAM quotas in the AWS account.

For information about limitations on IAM entities, see Limitations on IAM Entities in the Using IAM guide.

    GetCredentialReport( => )

Each argument is described in detail in: Paws::IAM::GetCredentialReport

Returns: a Paws::IAM::GetCredentialReportResponse instance

Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.

    GetGroup(GroupName => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::GetGroup

Returns: a Paws::IAM::GetGroupResponse instance

Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.

    GetGroupPolicy(GroupName => Str, PolicyName => Str)

Each argument is described in detail in: Paws::IAM::GetGroupPolicy

Returns: a Paws::IAM::GetGroupPolicyResponse instance

Retrieves the specified inline policy document that is embedded in the specified group.

A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy’s default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    GetInstanceProfile(InstanceProfileName => Str)

Each argument is described in detail in: Paws::IAM::GetInstanceProfile

Returns: a Paws::IAM::GetInstanceProfileResponse instance

Retrieves information about the specified instance profile, including the instance profile’s path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles. For more information about ARNs, go to ARNs.

    GetLoginProfile(UserName => Str)

Each argument is described in detail in: Paws::IAM::GetLoginProfile

Returns: a Paws::IAM::GetLoginProfileResponse instance

Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.

    GetOpenIDConnectProvider(OpenIDConnectProviderArn => Str)

Each argument is described in detail in: Paws::IAM::GetOpenIDConnectProvider

Returns: a Paws::IAM::GetOpenIDConnectProviderResponse instance

Returns information about the specified OpenID Connect provider.

    GetPolicy(PolicyArn => Str)

Each argument is described in detail in: Paws::IAM::GetPolicy

Returns: a Paws::IAM::GetPolicyResponse instance

Retrieves information about the specified managed policy, including the policy’s default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use GetPolicyVersion.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    GetPolicyVersion(PolicyArn => Str, VersionId => Str)

Each argument is described in detail in: Paws::IAM::GetPolicyVersion

Returns: a Paws::IAM::GetPolicyVersionResponse instance

Retrieves information about the specified version of the specified managed policy, including the policy document.

To list the available versions for a policy, use ListPolicyVersions.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about the types of policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    GetRole(RoleName => Str)

Each argument is described in detail in: Paws::IAM::GetRole

Returns: a Paws::IAM::GetRoleResponse instance

Retrieves information about the specified role, including the role’s path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles.

    GetRolePolicy(PolicyName => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::GetRolePolicy

Returns: a Paws::IAM::GetRolePolicyResponse instance

Retrieves the specified inline policy document that is embedded with the specified role.

A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy’s default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

    GetSAMLProvider(SAMLProviderArn => Str)

Each argument is described in detail in: Paws::IAM::GetSAMLProvider

Returns: a Paws::IAM::GetSAMLProviderResponse instance

Returns the SAML provider metadocument that was uploaded when the provider was created or updated.

This operation requires Signature Version 4.

    GetServerCertificate(ServerCertificateName => Str)

Each argument is described in detail in: Paws::IAM::GetServerCertificate

Returns: a Paws::IAM::GetServerCertificateResponse instance

Retrieves information about the specified server certificate.

    GetSSHPublicKey(Encoding => Str, SSHPublicKeyId => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::GetSSHPublicKey

Returns: a Paws::IAM::GetSSHPublicKeyResponse instance

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

    GetUser([UserName => Str])

Each argument is described in detail in: Paws::IAM::GetUser

Returns: a Paws::IAM::GetUserResponse instance

Retrieves information about the specified user, including the user’s creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request.

    GetUserPolicy(PolicyName => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::GetUserPolicy

Returns: a Paws::IAM::GetUserPolicyResponse instance

Retrieves the specified inline policy document that is embedded in the specified user.

A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy’s default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    ListAccessKeys([Marker => Str, MaxItems => Int, UserName => Str])

Each argument is described in detail in: Paws::IAM::ListAccessKeys

Returns: a Paws::IAM::ListAccessKeysResponse instance

Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.

    ListAccountAliases([Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListAccountAliases

Returns: a Paws::IAM::ListAccountAliasesResponse instance

Lists the account aliases associated with the account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters.

    ListAttachedGroupPolicies(GroupName => Str, [Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListAttachedGroupPolicies

Returns: a Paws::IAM::ListAttachedGroupPoliciesResponse instance

Lists all managed policies that are attached to the specified group.

A group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.

    ListAttachedRolePolicies(RoleName => Str, [Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListAttachedRolePolicies

Returns: a Paws::IAM::ListAttachedRolePoliciesResponse instance

Lists all managed policies that are attached to the specified role.

A role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list.

    ListAttachedUserPolicies(UserName => Str, [Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListAttachedUserPolicies

Returns: a Paws::IAM::ListAttachedUserPoliciesResponse instance

Lists all managed policies that are attached to the specified user.

A user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.

    ListEntitiesForPolicy(PolicyArn => Str, [EntityFilter => Str, Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListEntitiesForPolicy

Returns: a Paws::IAM::ListEntitiesForPolicyResponse instance

Lists all users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

    ListGroupPolicies(GroupName => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListGroupPolicies

Returns: a Paws::IAM::ListGroupPoliciesResponse instance

Lists the names of the inline policies that are embedded in the specified group.

A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the action returns an empty list.

    ListGroups([Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListGroups

Returns: a Paws::IAM::ListGroupsResponse instance

Lists the groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

    ListGroupsForUser(UserName => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListGroupsForUser

Returns: a Paws::IAM::ListGroupsForUserResponse instance

Lists the groups the specified user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

    ListInstanceProfiles([Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListInstanceProfiles

Returns: a Paws::IAM::ListInstanceProfilesResponse instance

Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

    ListInstanceProfilesForRole(RoleName => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListInstanceProfilesForRole

Returns: a Paws::IAM::ListInstanceProfilesForRoleResponse instance

Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

    ListMFADevices([Marker => Str, MaxItems => Int, UserName => Str])

Each argument is described in detail in: Paws::IAM::ListMFADevices

Returns: a Paws::IAM::ListMFADevicesResponse instance

Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.

You can paginate the results using the MaxItems and Marker parameters.

    ListOpenIDConnectProviders( => )

Each argument is described in detail in: Paws::IAM::ListOpenIDConnectProviders

Returns: a Paws::IAM::ListOpenIDConnectProvidersResponse instance

Lists information about the OpenID Connect providers in the AWS account.

    ListPolicies([Marker => Str, MaxItems => Int, OnlyAttached => Bool, PathPrefix => Str, Scope => Str])

Each argument is described in detail in: Paws::IAM::ListPolicies

Returns: a Paws::IAM::ListPoliciesResponse instance

Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    ListPolicyVersions(PolicyArn => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListPolicyVersions

Returns: a Paws::IAM::ListPolicyVersionsResponse instance

Lists information about the versions of the specified managed policy, including the version that is set as the policy’s default version.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    ListRolePolicies(RoleName => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListRolePolicies

Returns: a Paws::IAM::ListRolePoliciesResponse instance

Lists the names of the inline policies that are embedded in the specified role.

A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the action returns an empty list.

    ListRoles([Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListRoles

Returns: a Paws::IAM::ListRolesResponse instance

Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.

You can paginate the results using the MaxItems and Marker parameters.

    ListSAMLProviders( => )

Each argument is described in detail in: Paws::IAM::ListSAMLProviders

Returns: a Paws::IAM::ListSAMLProvidersResponse instance

Lists the SAML providers in the account.

This operation requires Signature Version 4.

    ListServerCertificates([Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListServerCertificates

Returns: a Paws::IAM::ListServerCertificatesResponse instance

Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

    ListSigningCertificates([Marker => Str, MaxItems => Int, UserName => Str])

Each argument is described in detail in: Paws::IAM::ListSigningCertificates

Returns: a Paws::IAM::ListSigningCertificatesResponse instance

Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

    ListSSHPublicKeys([Marker => Str, MaxItems => Int, UserName => Str])

Each argument is described in detail in: Paws::IAM::ListSSHPublicKeys

Returns: a Paws::IAM::ListSSHPublicKeysResponse instance

Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.

The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

    ListUserPolicies(UserName => Str, [Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListUserPolicies

Returns: a Paws::IAM::ListUserPoliciesResponse instance

Lists the names of the inline policies embedded in the specified user.

A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the action returns an empty list.

    ListUsers([Marker => Str, MaxItems => Int, PathPrefix => Str])

Each argument is described in detail in: Paws::IAM::ListUsers

Returns: a Paws::IAM::ListUsersResponse instance

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

    ListVirtualMFADevices([AssignmentStatus => Str, Marker => Str, MaxItems => Int])

Each argument is described in detail in: Paws::IAM::ListVirtualMFADevices

Returns: a Paws::IAM::ListVirtualMFADevicesResponse instance

Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

You can paginate the results using the MaxItems and Marker parameters.

    PutGroupPolicy(GroupName => Str, PolicyDocument => Str, PolicyName => Str)

Each argument is described in detail in: Paws::IAM::PutGroupPolicy

Returns: nothing

Adds (or updates) an inline policy document that is embedded in the specified 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, refer to Managed Policies and Inline Policies in the Using IAM guide.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the Using IAM guide.

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, go to Making Query Requests in the Using IAM guide.

    PutRolePolicy(PolicyDocument => Str, PolicyName => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::PutRolePolicy

Returns: nothing

Adds (or updates) an inline policy document that is embedded in the specified role.

When you embed an inline policy in a role, the inline policy is used as 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 roles, go to Using Roles to Delegate Permissions and Federate Identities.

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, refer to Managed Policies and Inline Policies in the Using IAM guide.

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the Using IAM guide.

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, go to Making Query Requests in the Using IAM guide.

    PutUserPolicy(PolicyDocument => Str, PolicyName => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::PutUserPolicy

Returns: nothing

Adds (or updates) an inline policy document that is embedded in the specified user.

A 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, refer to Managed Policies and Inline Policies in the Using IAM guide.

For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the Using IAM guide.

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, go to Making Query Requests in the Using IAM guide.

    RemoveClientIDFromOpenIDConnectProvider(ClientID => Str, OpenIDConnectProviderArn => Str)

Each argument is described in detail in: Paws::IAM::RemoveClientIDFromOpenIDConnectProvider

Returns: nothing

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider.

This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously.

    RemoveRoleFromInstanceProfile(InstanceProfileName => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::RemoveRoleFromInstanceProfile

Returns: nothing

Removes the specified role from the specified instance profile.

Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance will break any applications running on the instance.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

    RemoveUserFromGroup(GroupName => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::RemoveUserFromGroup

Returns: nothing

Removes the specified user from the specified group.

    ResyncMFADevice(AuthenticationCode1 => Str, AuthenticationCode2 => Str, SerialNumber => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::ResyncMFADevice

Returns: nothing

Synchronizes the specified MFA device with AWS servers.

For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.

    SetDefaultPolicyVersion(PolicyArn => Str, VersionId => Str)

Each argument is described in detail in: Paws::IAM::SetDefaultPolicyVersion

Returns: nothing

Sets the specified version of the specified policy as the policy’s default (operative) version.

This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.

For information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

    UpdateAccessKey(AccessKeyId => Str, Status => Str, [UserName => Str])

Each argument is described in detail in: Paws::IAM::UpdateAccessKey

Returns: nothing

Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user’s key as part of a key rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

For information about rotating keys, see Managing Keys and Certificates in the Using IAM guide.

    UpdateAccountPasswordPolicy([AllowUsersToChangePassword => Bool, HardExpiry => Bool, MaxPasswordAge => Int, MinimumPasswordLength => Int, PasswordReusePrevention => Int, RequireLowercaseCharacters => Bool, RequireNumbers => Bool, RequireSymbols => Bool, RequireUppercaseCharacters => Bool])

Each argument is described in detail in: Paws::IAM::UpdateAccountPasswordPolicy

Returns: nothing

Updates the password policy settings for the AWS account.

This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter’s value reverts to its default value. See the <B>Request ParametersB> section for each parameter’s default value.

For more information about using a password policy, see Managing an IAM Password Policy in the Using IAM guide.

    UpdateAssumeRolePolicy(PolicyDocument => Str, RoleName => Str)

Each argument is described in detail in: Paws::IAM::UpdateAssumeRolePolicy

Returns: nothing

Updates the policy that grants an entity permission to assume a role. For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

    UpdateGroup(GroupName => Str, [NewGroupName => Str, NewPath => Str])

Each argument is described in detail in: Paws::IAM::UpdateGroup

Returns: nothing

Updates the name and/or the path of the specified group.

You should understand the implications of changing a group’s path or name. For more information, see Renaming Users and Groups in the Using IAM guide. To change a group name the requester must have appropriate permissions on both the source object and the target object. For example, to change Managers to MGRs, the entity making the request must have permission on Managers and MGRs, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

    UpdateLoginProfile(UserName => Str, [Password => Str, PasswordResetRequired => Bool])

Each argument is described in detail in: Paws::IAM::UpdateLoginProfile

Returns: nothing

Changes the password for the specified user.

Users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the Using IAM guide.

    UpdateOpenIDConnectProviderThumbprint(OpenIDConnectProviderArn => Str, ThumbprintList => ArrayRef[Str])

Each argument is described in detail in: Paws::IAM::UpdateOpenIDConnectProviderThumbprint

Returns: nothing

Replaces the existing list of server certificate thumbprints with a new list.

The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider’s certificate changes, which occurs rarely. However, if the provider’s certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated.

Because trust for the OpenID Connect provider is ultimately derived from the provider’s certificate and is validated by the thumbprint, it is a best practice to limit access to the UpdateOpenIDConnectProviderThumbprint action to highly-privileged users.

    UpdateSAMLProvider(SAMLMetadataDocument => Str, SAMLProviderArn => Str)

Each argument is described in detail in: Paws::IAM::UpdateSAMLProvider

Returns: a Paws::IAM::UpdateSAMLProviderResponse instance

Updates the metadata document for an existing SAML provider.

This operation requires Signature Version 4.

    UpdateServerCertificate(ServerCertificateName => Str, [NewPath => Str, NewServerCertificateName => Str])

Each argument is described in detail in: Paws::IAM::UpdateServerCertificate

Returns: nothing

Updates the name and/or the path of the specified server certificate.

You should understand the implications of changing a server certificate’s path or name. For more information, see Managing Server Certificates in the Using IAM guide. To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

    UpdateSigningCertificate(CertificateId => Str, Status => Str, [UserName => Str])

Each argument is described in detail in: Paws::IAM::UpdateSigningCertificate

Returns: nothing

Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user’s signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

    UpdateSSHPublicKey(SSHPublicKeyId => Str, Status => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::UpdateSSHPublicKey

Returns: nothing

Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user’s SSH public key as part of a key rotation work flow.

The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

    UpdateUser(UserName => Str, [NewPath => Str, NewUserName => Str])

Each argument is described in detail in: Paws::IAM::UpdateUser

Returns: nothing

Updates the name and/or the path of the specified user.

You should understand the implications of changing a user’s path or name. For more information, see Renaming Users and Groups in the Using IAM guide. To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

    UploadServerCertificate(CertificateBody => Str, PrivateKey => Str, ServerCertificateName => Str, [CertificateChain => Str, Path => Str])

Each argument is described in detail in: Paws::IAM::UploadServerCertificate

Returns: a Paws::IAM::UploadServerCertificateResponse instance

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

For information about the number of server certificates you can upload, see Limitations on IAM Entities in the Using IAM guide.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide.

    UploadSigningCertificate(CertificateBody => Str, [UserName => Str])

Each argument is described in detail in: Paws::IAM::UploadSigningCertificate

Returns: a Paws::IAM::UploadSigningCertificateResponse instance

Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAMguide.

    UploadSSHPublicKey(SSHPublicKeyBody => Str, UserName => Str)

Each argument is described in detail in: Paws::IAM::UploadSSHPublicKey

Returns: a Paws::IAM::UploadSSHPublicKeyResponse instance

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::IAM (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.