AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessKey

Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

Class AccessKeyLastUsed

Contains information about the last time an AWS access key was used.

This data type is used as a response element in the GetAccessKeyLastUsed action.

Class AccessKeyMetadata

Contains information about an AWS access key, without its secret key.

This data type is used as a response element in the ListAccessKeys action.

Class AddClientIDToOpenIDConnectProviderRequest

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

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

Class AddClientIDToOpenIDConnectProviderResponse

This is the response object from the AddClientIDToOpenIDConnectProvider operation.

Class AddRoleToInstanceProfileRequest

Container for the parameters to the AddRoleToInstanceProfile operation. Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased.

The caller of this API must be granted the PassRole permission on the IAM role by a permission policy.

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

Class AddRoleToInstanceProfileResponse

This is the response object from the AddRoleToInstanceProfile operation.

Class AddUserToGroupRequest

Container for the parameters to the AddUserToGroup operation. Adds the specified user to the specified group.

Class AddUserToGroupResponse

This is the response object from the AddUserToGroup operation.

Class AttachedPolicyType

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails actions.

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

Class AttachGroupPolicyRequest

Container for the parameters to the AttachGroupPolicy operation. Attaches the specified managed policy to the specified IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class AttachGroupPolicyResponse

This is the response object from the AttachGroupPolicy operation.

Class AttachRolePolicyRequest

Container for the parameters to the AttachRolePolicy operation. 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.

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, see Managed Policies and Inline Policies in the IAM User Guide.

Class AttachRolePolicyResponse

This is the response object from the AttachRolePolicy operation.

Class AttachUserPolicyRequest

Container for the parameters to the AttachUserPolicy operation. 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class AttachUserPolicyResponse

This is the response object from the AttachUserPolicy operation.

Class ChangePasswordRequest

Container for the parameters to the ChangePassword operation. 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 IAM User Guide.

Class ChangePasswordResponse

This is the response object from the ChangePassword operation.

Class ContextEntry

Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulateCustomPolicy and SimulateCustomPolicy.

Class CreateAccessKeyRequest

Container for the parameters to the CreateAccessKey operation. 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 IAM User 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.

Class CreateAccessKeyResponse

Contains the response to a successful CreateAccessKey request.

Class CreateAccountAliasRequest

Container for the parameters to the CreateAccountAlias operation. 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 IAM User Guide.

Class CreateAccountAliasResponse

This is the response object from the CreateAccountAlias operation.

Class CreateGroupRequest

Container for the parameters to the CreateGroup operation. Creates a new group.

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

Class CreateGroupResponse

Contains the response to a successful CreateGroup request.

Class CreateInstanceProfileRequest

Container for the parameters to the CreateInstanceProfile operation. 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 IAM User Guide.

Class CreateInstanceProfileResponse

Contains the response to a successful CreateInstanceProfile request.

Class CreateLoginProfileRequest

Container for the parameters to the CreateLoginProfile operation. 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 IAM User Guide.

Class CreateLoginProfileResponse

Contains the response to a successful CreateLoginProfile request.

Class CreateOpenIDConnectProviderRequest

Container for the parameters to the CreateOpenIDConnectProvider operation. 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.

Class CreateOpenIDConnectProviderResponse

Contains the response to a successful CreateOpenIDConnectProvider request.

Class CreatePolicyRequest

Container for the parameters to the CreatePolicy operation. 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 IAM User Guide.

For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.

Class CreatePolicyResponse

Contains the response to a successful CreatePolicy request.

Class CreatePolicyVersionRequest

Container for the parameters to the CreatePolicyVersion operation. 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 version that is in effect for the IAM users, groups, and roles to which the policy is attached.

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

Class CreatePolicyVersionResponse

Contains the response to a successful CreatePolicyVersion request.

Class CreateRoleRequest

Container for the parameters to the CreateRole operation. 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 IAM User Guide.

Class CreateRoleResponse

Contains the response to a successful CreateRole request.

Class CreateSAMLProviderRequest

Container for the parameters to the CreateSAMLProvider operation. Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. 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 resource, 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 the IdP sends. 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 Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.

Class CreateSAMLProviderResponse

Contains the response to a successful CreateSAMLProvider request.

Class CreateServiceLinkedRoleRequest

Container for the parameters to the CreateServiceLinkedRole operation. Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed.

The name of the role is autogenerated by combining the string that you specify for the AWSServiceName parameter with the string that you specify for the CustomSuffix parameter. The resulting name must be unique in your account or the request fails.

To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role.

Class CreateServiceLinkedRoleResponse

This is the response object from the CreateServiceLinkedRole operation.

Class CreateServiceSpecificCredentialRequest

Container for the parameters to the CreateServiceSpecificCredential operation. Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

The only supported service at this time is AWS CodeCommit.

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide.

Class CreateServiceSpecificCredentialResponse

This is the response object from the CreateServiceSpecificCredential operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. Creates a new IAM user for your AWS account.

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

Class CreateUserResponse

Contains the response to a successful CreateUser request.

Class CreateVirtualMFADeviceRequest

Container for the parameters to the CreateVirtualMFADevice operation. 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 IAM User Guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User 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.

Class CreateVirtualMFADeviceResponse

Contains the response to a successful CreateVirtualMFADevice request.

Class CredentialReportExpiredException

IdentityManagementService exception

Class CredentialReportNotPresentException

IdentityManagementService exception

Class CredentialReportNotReadyException

IdentityManagementService exception

Class DeactivateMFADeviceRequest

Container for the parameters to the DeactivateMFADevice operation. 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 IAM User Guide.

Class DeactivateMFADeviceResponse

This is the response object from the DeactivateMFADevice operation.

Class DeleteAccessKeyRequest

Container for the parameters to the DeleteAccessKey operation. Deletes the access key pair associated with the specified IAM 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.

Class DeleteAccessKeyResponse

This is the response object from the DeleteAccessKey operation.

Class DeleteAccountAliasRequest

Container for the parameters to the DeleteAccountAlias operation. 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 IAM User Guide.

Class DeleteAccountAliasResponse

This is the response object from the DeleteAccountAlias operation.

Class DeleteAccountPasswordPolicyRequest

Container for the parameters to the DeleteAccountPasswordPolicy operation. Deletes the password policy for the AWS account. There are no parameters.

Class DeleteAccountPasswordPolicyResponse

This is the response object from the DeleteAccountPasswordPolicy operation.

Class DeleteConflictException

IdentityManagementService exception

Class DeleteGroupPolicyRequest

Container for the parameters to the DeleteGroupPolicy operation. Deletes the specified inline policy that is embedded in the specified IAM 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 IAM User Guide.

Class DeleteGroupPolicyResponse

This is the response object from the DeleteGroupPolicy operation.

Class DeleteGroupRequest

Container for the parameters to the DeleteGroup operation. Deletes the specified IAM group. The group must not contain any users or have any attached policies.

Class DeleteGroupResponse

This is the response object from the DeleteGroup operation.

Class DeleteInstanceProfileRequest

Container for the parameters to the DeleteInstanceProfile operation. 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.

Class DeleteInstanceProfileResponse

This is the response object from the DeleteInstanceProfile operation.

Class DeleteLoginProfileRequest

Container for the parameters to the DeleteLoginProfile operation. Deletes the password for the specified IAM 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 AWS through the command line interface or the API. To prevent all user access you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

Class DeleteLoginProfileResponse

This is the response object from the DeleteLoginProfile operation.

Class DeleteOpenIDConnectProviderRequest

Container for the parameters to the DeleteOpenIDConnectProvider operation. Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource 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 deleted provider fails.

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

Class DeleteOpenIDConnectProviderResponse

This is the response object from the DeleteOpenIDConnectProvider operation.

Class DeletePolicyRequest

Container for the parameters to the DeletePolicy operation. Deletes the specified managed policy.

Before you can delete a managed policy, you must first 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:

  • 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.

  • 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.

  • Delete the policy (this automatically deletes the policy's default version) using this API.

For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Class DeletePolicyResponse

This is the response object from the DeletePolicy operation.

Class DeletePolicyVersionRequest

Container for the parameters to the DeletePolicyVersion operation. Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this API. To delete the default version from 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, see Versioning for Managed Policies in the IAM User Guide.

Class DeletePolicyVersionResponse

This is the response object from the DeletePolicyVersion operation.

Class DeleteRolePolicyRequest

Container for the parameters to the DeleteRolePolicy operation. Deletes the specified inline policy that is embedded in the specified IAM 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 IAM User Guide.

Class DeleteRolePolicyResponse

This is the response object from the DeleteRolePolicy operation.

Class DeleteRoleRequest

Container for the parameters to the DeleteRole operation. 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.

Class DeleteRoleResponse

This is the response object from the DeleteRole operation.

Class DeleteSAMLProviderRequest

Container for the parameters to the DeleteSAMLProvider operation. Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

Class DeleteSAMLProviderResponse

This is the response object from the DeleteSAMLProvider operation.

Class DeleteServerCertificateRequest

Container for the parameters to the DeleteServerCertificate operation. Deletes the specified server certificate.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

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.

Class DeleteServerCertificateResponse

This is the response object from the DeleteServerCertificate operation.

Class DeleteServiceLinkedRoleRequest

Container for the parameters to the DeleteServiceLinkedRole operation. Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus API operation returns the reason for the failure, including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service.

For more information about service-linked roles, see Roles Terms and Concepts: AWS Service-Linked Role in the IAM User Guide.

Class DeleteServiceLinkedRoleResponse

This is the response object from the DeleteServiceLinkedRole operation.

Class DeleteServiceSpecificCredentialRequest

Container for the parameters to the DeleteServiceSpecificCredential operation. Deletes the specified service-specific credential.

Class DeleteServiceSpecificCredentialResponse

This is the response object from the DeleteServiceSpecificCredential operation.

Class DeleteSigningCertificateRequest

Container for the parameters to the DeleteSigningCertificate operation. Deletes a signing certificate associated with the specified IAM 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 IAM users.

Class DeleteSigningCertificateResponse

This is the response object from the DeleteSigningCertificate operation.

Class DeleteSSHPublicKeyRequest

Container for the parameters to the DeleteSSHPublicKey operation. 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.

Class DeleteSSHPublicKeyResponse

This is the response object from the DeleteSSHPublicKey operation.

Class DeleteUserPolicyRequest

Container for the parameters to the DeleteUserPolicy operation. Deletes the specified inline policy that is embedded in the specified IAM 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 IAM User Guide.

Class DeleteUserPolicyResponse

This is the response object from the DeleteUserPolicy operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.

Class DeleteUserResponse

This is the response object from the DeleteUser operation.

Class DeleteVirtualMFADeviceRequest

Container for the parameters to the DeleteVirtualMFADevice operation. 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.

Class DeleteVirtualMFADeviceResponse

This is the response object from the DeleteVirtualMFADevice operation.

Class DeletionTaskFailureReasonType

The reason that the service-linked role deletion failed.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

Class DetachGroupPolicyRequest

Container for the parameters to the DetachGroupPolicy operation. Removes the specified managed policy from the specified IAM group.

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

Class DetachGroupPolicyResponse

This is the response object from the DetachGroupPolicy operation.

Class DetachRolePolicyRequest

Container for the parameters to the DetachRolePolicy operation. 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class DetachRolePolicyResponse

This is the response object from the DetachRolePolicy operation.

Class DetachUserPolicyRequest

Container for the parameters to the DetachUserPolicy operation. 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class DetachUserPolicyResponse

This is the response object from the DetachUserPolicy operation.

Class DuplicateCertificateException

IdentityManagementService exception

Class DuplicateSSHPublicKeyException

IdentityManagementService exception

Class EnableMFADeviceRequest

Container for the parameters to the EnableMFADevice operation. Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

Class EnableMFADeviceResponse

This is the response object from the EnableMFADevice operation.

Class EntityAlreadyExistsException

IdentityManagementService exception

Class EntityTemporarilyUnmodifiableException

IdentityManagementService exception

Class EvaluationResult

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy.

Class GenerateCredentialReportRequest

Container for the parameters to the GenerateCredentialReport operation. Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

Class GenerateCredentialReportResponse

Contains the response to a successful GenerateCredentialReport request.

Class GetAccessKeyLastUsedRequest

Container for the parameters to the GetAccessKeyLastUsed operation. 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.

Class GetAccessKeyLastUsedResponse

Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.

Class GetAccountAuthorizationDetailsRequest

Container for the parameters to the GetAccountAuthorizationDetails operation. Retrieves information about all IAM users, groups, roles, and policies in your AWS 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.

Class GetAccountAuthorizationDetailsResponse

Contains the response to a successful GetAccountAuthorizationDetails request.

Class GetAccountPasswordPolicyRequest

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

Class GetAccountPasswordPolicyResponse

Contains the response to a successful GetAccountPasswordPolicy request.

Class GetAccountSummaryRequest

Container for the parameters to the GetAccountSummary operation. 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 IAM User Guide.

Class GetAccountSummaryResponse

Contains the response to a successful GetAccountSummary request.

Class GetContextKeysForCustomPolicyRequest

Container for the parameters to the GetContextKeysForCustomPolicy operation. Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

Class GetContextKeysForCustomPolicyResponse

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

Class GetContextKeysForPrincipalPolicyRequest

Container for the parameters to the GetContextKeysForPrincipalPolicy operation. Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

Class GetContextKeysForPrincipalPolicyResponse

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

Class GetCredentialReportRequest

Container for the parameters to the GetCredentialReport operation. Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

Class GetCredentialReportResponse

Contains the response to a successful GetCredentialReport request.

Class GetGroupPolicyRequest

Container for the parameters to the GetGroupPolicy operation. Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class GetGroupPolicyResponse

Contains the response to a successful GetGroupPolicy request.

Class GetGroupRequest

Container for the parameters to the GetGroup operation. Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

Class GetGroupResponse

Contains the response to a successful GetGroup request.

Class GetInstanceProfileRequest

Container for the parameters to the GetInstanceProfile operation. Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide.

Class GetInstanceProfileResponse

Contains the response to a successful GetInstanceProfile request.

Class GetLoginProfileRequest

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

Class GetLoginProfileResponse

Contains the response to a successful GetLoginProfile request.

Class GetOpenIDConnectProviderRequest

Container for the parameters to the GetOpenIDConnectProvider operation. Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

Class GetOpenIDConnectProviderResponse

Contains the response to a successful GetOpenIDConnectProvider request.

Class GetPolicyRequest

Container for the parameters to the GetPolicy operation. Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the 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 actual 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 an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

Class GetPolicyResponse

Contains the response to a successful GetPolicy request.

Class GetPolicyVersionRequest

Container for the parameters to the GetPolicyVersion operation. Retrieves information about the specified version of the specified managed policy, including the policy document.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

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, see Managed Policies and Inline Policies in the IAM User Guide.

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

Class GetPolicyVersionResponse

Contains the response to a successful GetPolicyVersion request.

Class GetRolePolicyRequest

Container for the parameters to the GetRolePolicy operation. Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

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

Class GetRolePolicyResponse

Contains the response to a successful GetRolePolicy request.

Class GetRoleRequest

Container for the parameters to the GetRole operation. Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Class GetRoleResponse

Contains the response to a successful GetRole request.

Class GetSAMLProviderRequest

Container for the parameters to the GetSAMLProvider operation. Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

Class GetSAMLProviderResponse

Contains the response to a successful GetSAMLProvider request.

Class GetServerCertificateRequest

Container for the parameters to the GetServerCertificate operation. Retrieves information about the specified server certificate stored in IAM.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

Class GetServerCertificateResponse

Contains the response to a successful GetServerCertificate request.

Class GetServiceLinkedRoleDeletionStatusRequest

Container for the parameters to the GetServiceLinkedRoleDeletionStatus operation. Retrieves the status of your service-linked role deletion. After you use the DeleteServiceLinkedRole API operation to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed.

Class GetServiceLinkedRoleDeletionStatusResponse

This is the response object from the GetServiceLinkedRoleDeletionStatus operation.

Class GetSSHPublicKeyRequest

Container for the parameters to the GetSSHPublicKey operation. 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.

Class GetSSHPublicKeyResponse

Contains the response to a successful GetSSHPublicKey request.

Class GetUserPolicyRequest

Container for the parameters to the GetUserPolicy operation. Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class GetUserPolicyResponse

Contains the response to a successful GetUserPolicy request.

Class GetUserRequest

Container for the parameters to the GetUser operation. Retrieves information about the specified IAM 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 to this API.

Class GetUserResponse

Contains the response to a successful GetUser request.

Class Group

Contains information about an IAM group entity.

This data type is used as a response element in the following actions:

Class GroupDetail

Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class InstanceProfile

Contains information about an instance profile.

This data type is used as a response element in the following actions:

Class InvalidAuthenticationCodeException

IdentityManagementService exception

Class InvalidCertificateException

IdentityManagementService exception

Class InvalidInputException

IdentityManagementService exception

Class InvalidPublicKeyException

IdentityManagementService exception

Class InvalidUserTypeException

IdentityManagementService exception

Class KeyPairMismatchException

IdentityManagementService exception

Class LimitExceededException

IdentityManagementService exception

Class ListAccessKeysRequest

Container for the parameters to the ListAccessKeys operation. Returns information about the access key IDs associated with the specified IAM 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.

Class ListAccessKeysResponse

Contains the response to a successful ListAccessKeys request.

Class ListAccountAliasesRequest

Container for the parameters to the ListAccountAliases operation. Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

Class ListAccountAliasesResponse

Contains the response to a successful ListAccountAliases request.

Class ListAttachedGroupPoliciesRequest

Container for the parameters to the ListAttachedGroupPolicies operation. Lists all managed policies that are attached to the specified IAM group.

An IAM 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, see Managed Policies and Inline Policies in the IAM User 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.

Class ListAttachedGroupPoliciesResponse

Contains the response to a successful ListAttachedGroupPolicies request.

Class ListAttachedRolePoliciesRequest

Container for the parameters to the ListAttachedRolePolicies operation. Lists all managed policies that are attached to the specified IAM role.

An IAM 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, see Managed Policies and Inline Policies in the IAM User 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.

Class ListAttachedRolePoliciesResponse

Contains the response to a successful ListAttachedRolePolicies request.

Class ListAttachedUserPoliciesRequest

Container for the parameters to the ListAttachedUserPolicies operation. Lists all managed policies that are attached to the specified IAM user.

An IAM 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, see Managed Policies and Inline Policies in the IAM User 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.

Class ListAttachedUserPoliciesResponse

Contains the response to a successful ListAttachedUserPolicies request.

Class ListEntitiesForPolicyRequest

Container for the parameters to the ListEntitiesForPolicy operation. Lists all IAM 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.

Class ListEntitiesForPolicyResponse

Contains the response to a successful ListEntitiesForPolicy request.

Class ListGroupPoliciesRequest

Container for the parameters to the ListGroupPolicies operation. Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM 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, see Managed Policies and Inline Policies in the IAM User 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.

Class ListGroupPoliciesResponse

Contains the response to a successful ListGroupPolicies request.

Class ListGroupsForUserRequest

Container for the parameters to the ListGroupsForUser operation. Lists the IAM groups that the specified IAM user belongs to.

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

Class ListGroupsForUserResponse

Contains the response to a successful ListGroupsForUser request.

Class ListGroupsRequest

Container for the parameters to the ListGroups operation. Lists the IAM groups that have the specified path prefix.

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

Class ListGroupsResponse

Contains the response to a successful ListGroups request.

Class ListInstanceProfilesForRoleRequest

Container for the parameters to the ListInstanceProfilesForRole operation. Lists the instance profiles that have the specified associated IAM 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.

Class ListInstanceProfilesForRoleResponse

Contains the response to a successful ListInstanceProfilesForRole request.

Class ListInstanceProfilesRequest

Container for the parameters to the ListInstanceProfiles operation. 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.

Class ListInstanceProfilesResponse

Contains the response to a successful ListInstanceProfiles request.

Class ListMFADevicesRequest

Container for the parameters to the ListMFADevices operation. Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices 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 for this API.

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

Class ListMFADevicesResponse

Contains the response to a successful ListMFADevices request.

Class ListOpenIDConnectProvidersRequest

Container for the parameters to the ListOpenIDConnectProviders operation. Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.

Class ListOpenIDConnectProvidersResponse

Contains the response to a successful ListOpenIDConnectProviders request.

Class ListPoliciesRequest

Container for the parameters to the ListPolicies operation. Lists all the managed policies that are available in your AWS account, including your own customer-defined 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class ListPoliciesResponse

Contains the response to a successful ListPolicies request.

Class ListPolicyVersionsRequest

Container for the parameters to the ListPolicyVersions operation. Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

Class ListPolicyVersionsResponse

Contains the response to a successful ListPolicyVersions request.

Class ListRolePoliciesRequest

Container for the parameters to the ListRolePolicies operation. Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM 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, see Managed Policies and Inline Policies in the IAM User 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.

Class ListRolePoliciesResponse

Contains the response to a successful ListRolePolicies request.

Class ListRolesRequest

Container for the parameters to the ListRoles operation. Lists the IAM 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.

Class ListRolesResponse

Contains the response to a successful ListRoles request.

Class ListSAMLProvidersRequest

Container for the parameters to the ListSAMLProviders operation. Lists the SAML provider resource objects defined in IAM in the account.

This operation requires Signature Version 4.

Class ListSAMLProvidersResponse

Contains the response to a successful ListSAMLProviders request.

Class ListServerCertificatesRequest

Container for the parameters to the ListServerCertificates operation. Lists the server certificates stored in IAM 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.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

Class ListServerCertificatesResponse

Contains the response to a successful ListServerCertificates request.

Class ListServiceSpecificCredentialsRequest

Container for the parameters to the ListServiceSpecificCredentials operation. Returns information about the service-specific credentials associated with the specified IAM user. If there are none, the action returns an empty list. The service-specific credentials returned by this action are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide.

Class ListServiceSpecificCredentialsResponse

This is the response object from the ListServiceSpecificCredentials operation.

Class ListSigningCertificatesRequest

Container for the parameters to the ListSigningCertificates operation. Returns information about the signing certificates associated with the specified IAM 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 for this API. 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.

Class ListSigningCertificatesResponse

Contains the response to a successful ListSigningCertificates request.

Class ListSSHPublicKeysRequest

Container for the parameters to the ListSSHPublicKeys operation. 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.

Class ListSSHPublicKeysResponse

Contains the response to a successful ListSSHPublicKeys request.

Class ListUserPoliciesRequest

Container for the parameters to the ListUserPolicies operation. Lists the names of the inline policies embedded in the specified IAM user.

An IAM 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, see Managed Policies and Inline Policies in the IAM User 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.

Class ListUserPoliciesResponse

Contains the response to a successful ListUserPolicies request.

Class ListUsersRequest

Container for the parameters to the ListUsers operation. 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.

Class ListUsersResponse

Contains the response to a successful ListUsers request.

Class ListVirtualMFADevicesRequest

Container for the parameters to the ListVirtualMFADevices operation. Lists the virtual MFA devices defined in 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.

Class ListVirtualMFADevicesResponse

Contains the response to a successful ListVirtualMFADevices request.

Class LoginProfile

Contains the user name and password create date for a user.

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile actions.

Class MalformedCertificateException

IdentityManagementService exception

Class MalformedPolicyDocumentException

IdentityManagementService exception

Class ManagedPolicy

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies actions.

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

Class ManagedPolicyDetail

Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

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

Class MFADevice

Contains information about an MFA device.

This data type is used as a response element in the ListMFADevices action.

Class NoSuchEntityException

IdentityManagementService exception

Class OpenIDConnectProviderListEntry

Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

Class OrganizationsDecisionDetail

Contains information about AWS Organizations's affect on a policy simulation.

Class PasswordPolicy

Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy action.

Class PasswordPolicyViolationException

IdentityManagementService exception

Class PolicyDetail

Contains information about an IAM policy, including the policy document.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class PolicyEvaluationException

IdentityManagementService exception

Class PolicyGroup

Contains information about a group that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

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

Class PolicyNotAttachableException

IdentityManagementService exception

Class PolicyRole

Contains information about a role that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

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

Class PolicyUser

Contains information about a user that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

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

Class PolicyVersion

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails actions.

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

Class Position

Contains the row and column of a location of a Statement element in a policy document.

This data type is used as a member of the Statement type.

Class PutGroupPolicyRequest

Container for the parameters to the PutGroupPolicy operation. 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 in the IAM User 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 IAM User 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 IAM User Guide.

Class PutGroupPolicyResponse

This is the response object from the PutGroupPolicy operation.

Class PutRolePolicyRequest

Container for the parameters to the PutRolePolicy operation. 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, 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, see Managed Policies and Inline Policies in the IAM User 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 IAM User 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 IAM User Guide.

Class PutRolePolicyResponse

This is the response object from the PutRolePolicy operation.

Class PutUserPolicyRequest

Container for the parameters to the PutUserPolicy operation. 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 in the IAM User 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 IAM User 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 IAM User Guide.

Class PutUserPolicyResponse

This is the response object from the PutUserPolicy operation.

Class RemoveClientIDFromOpenIDConnectProviderRequest

Container for the parameters to the RemoveClientIDFromOpenIDConnectProvider operation. Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

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

Class RemoveClientIDFromOpenIDConnectProviderResponse

This is the response object from the RemoveClientIDFromOpenIDConnectProvider operation.

Class RemoveRoleFromInstanceProfileRequest

Container for the parameters to the RemoveRoleFromInstanceProfile operation. Removes the specified IAM role from the specified EC2 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 might break any applications running on the instance.

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

Class RemoveRoleFromInstanceProfileResponse

This is the response object from the RemoveRoleFromInstanceProfile operation.

Class RemoveUserFromGroupRequest

Container for the parameters to the RemoveUserFromGroup operation. Removes the specified user from the specified group.

Class RemoveUserFromGroupResponse

This is the response object from the RemoveUserFromGroup operation.

Class ResetServiceSpecificCredentialRequest

Container for the parameters to the ResetServiceSpecificCredential operation. Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

Class ResetServiceSpecificCredentialResponse

This is the response object from the ResetServiceSpecificCredential operation.

Class ResourceSpecificResult

Contains the result of the simulation of a single API action call on a single resource.

This data type is used by a member of the EvaluationResult data type.

Class ResyncMFADeviceRequest

Container for the parameters to the ResyncMFADevice operation. Synchronizes the specified MFA device with its IAM resource object on the AWS servers.

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

Class ResyncMFADeviceResponse

This is the response object from the ResyncMFADevice operation.

Class Role

Contains information about an IAM role. This structure is returned as a response element in several APIs that interact with roles.

Class RoleDetail

Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class RoleUsageType

An object that contains details about how a service-linked role is used.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

Class SAMLProviderListEntry

Contains the list of SAML providers for this account.

Class ServerCertificate

Contains information about a server certificate.

This data type is used as a response element in the GetServerCertificate action.

Class ServerCertificateMetadata

Contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates actions.

Class ServiceFailureException

IdentityManagementService exception

Class ServiceNotSupportedException

IdentityManagementService exception

Class ServiceSpecificCredential

Contains the details of a service specific credential.

Class ServiceSpecificCredentialMetadata

Contains additional details about a service-specific credential.

Class SetDefaultPolicyVersionRequest

Container for the parameters to the SetDefaultPolicyVersion operation. 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, see Managed Policies and Inline Policies in the IAM User Guide.

Class SetDefaultPolicyVersionResponse

This is the response object from the SetDefaultPolicyVersion operation.

Class SigningCertificate

Contains information about an X.509 signing certificate.

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.

Class SimulateCustomPolicyRequest

Container for the parameters to the SimulateCustomPolicy operation. Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.

If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

Class SimulateCustomPolicyResponse

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

Class SimulatePrincipalPolicyRequest

Container for the parameters to the SimulatePrincipalPolicy operation. Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to .

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.

The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

Class SimulatePrincipalPolicyResponse

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

Class SSHPublicKey

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey actions.

Class SSHPublicKeyMetadata

Contains information about an SSH public key, without the key's body or fingerprint.

This data type is used as a response element in the ListSSHPublicKeys action.

Class Statement

Contains a reference to a Statement element in a policy document that determines the result of the simulation.

This data type is used by the MatchedStatements member of the EvaluationResult type.

Class UnmodifiableEntityException

IdentityManagementService exception

Class UnrecognizedPublicKeyEncodingException

IdentityManagementService exception

Class UpdateAccessKeyRequest

Container for the parameters to the UpdateAccessKey operation. 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 IAM User Guide.

Class UpdateAccessKeyResponse

This is the response object from the UpdateAccessKey operation.

Class UpdateAccountPasswordPolicyRequest

Container for the parameters to the UpdateAccountPasswordPolicy operation. 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 Request Parameters section for each parameter's default value.

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

Class UpdateAccountPasswordPolicyResponse

This is the response object from the UpdateAccountPasswordPolicy operation.

Class UpdateAssumeRolePolicyRequest

Container for the parameters to the UpdateAssumeRolePolicy operation. Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

Class UpdateAssumeRolePolicyResponse

This is the response object from the UpdateAssumeRolePolicy operation.

Class UpdateGroupRequest

Container for the parameters to the UpdateGroup operation. Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.

To change an IAM 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 both "Managers" and "MGRs", or must have permission on all (*). For more information about permissions, see Permissions and Policies.

Class UpdateGroupResponse

This is the response object from the UpdateGroup operation.

Class UpdateLoginProfileRequest

Container for the parameters to the UpdateLoginProfile operation. Changes the password for the specified IAM user.

IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.

Class UpdateLoginProfileResponse

This is the response object from the UpdateLoginProfile operation.

Class UpdateOpenIDConnectProviderThumbprintRequest

Container for the parameters to the UpdateOpenIDConnectProviderThumbprint operation. Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

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 fails until the certificate thumbprint is updated.

Because trust for the OIDC 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.

Class UpdateOpenIDConnectProviderThumbprintResponse

This is the response object from the UpdateOpenIDConnectProviderThumbprint operation.

Class UpdateRoleDescriptionRequest

Container for the parameters to the UpdateRoleDescription operation. Modifies the description of a role.

Class UpdateRoleDescriptionResponse

This is the response object from the UpdateRoleDescription operation.

Class UpdateSAMLProviderRequest

Container for the parameters to the UpdateSAMLProvider operation. Updates the metadata document for an existing SAML provider resource object.

This operation requires Signature Version 4.

Class UpdateSAMLProviderResponse

Contains the response to a successful UpdateSAMLProvider request.

Class UpdateServerCertificateRequest

Container for the parameters to the UpdateServerCertificate operation. Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User 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 Access Management in the IAM User Guide.

Class UpdateServerCertificateResponse

This is the response object from the UpdateServerCertificate operation.

Class UpdateServiceSpecificCredentialRequest

Container for the parameters to the UpdateServiceSpecificCredential operation. Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This action can be used to disable a user’s service-specific credential as part of a credential rotation work flow.

Class UpdateServiceSpecificCredentialResponse

This is the response object from the UpdateServiceSpecificCredential operation.

Class UpdateSigningCertificateRequest

Container for the parameters to the UpdateSigningCertificate operation. Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM 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.

Class UpdateSigningCertificateResponse

This is the response object from the UpdateSigningCertificate operation.

Class UpdateSSHPublicKeyRequest

Container for the parameters to the UpdateSSHPublicKey operation. Sets the status of an IAM user's 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.

Class UpdateSSHPublicKeyResponse

This is the response object from the UpdateSSHPublicKey operation.

Class UpdateUserRequest

Container for the parameters to the UpdateUser operation. Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User 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.

Class UpdateUserResponse

This is the response object from the UpdateUser operation.

Class UploadServerCertificateRequest

Container for the parameters to the UploadServerCertificate operation. 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.

We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User 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 Calling the API by Making HTTP Query Requests in the IAM User Guide.

Class UploadServerCertificateResponse

Contains the response to a successful UploadServerCertificate request.

Class UploadSigningCertificateRequest

Container for the parameters to the UploadSigningCertificate operation. Uploads an X.509 signing certificate and associates it with the specified IAM 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 IAM 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 IAM User Guide.

Class UploadSigningCertificateResponse

Contains the response to a successful UploadSigningCertificate request.

Class UploadSSHPublicKeyRequest

Container for the parameters to the UploadSSHPublicKey operation. 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.

Class UploadSSHPublicKeyResponse

Contains the response to a successful UploadSSHPublicKey request.

Class User

Contains information about an IAM user entity.

This data type is used as a response element in the following actions:

Class UserDetail

Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

Class VirtualMFADevice

Contains information about a virtual MFA device.