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": "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": "Adds the specified user to the specified group.
", "AttachGroupPolicy": "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": "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": "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": "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": " 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.
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": "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": "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": "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": "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.
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": "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": "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 example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
", "CreateSAMLProvider": "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.
For more information, see Giving Console Access Using SAML and Creating Temporary Security Credentials for SAML Federation in the Using Temporary Credentials guide.
", "CreateUser": "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": "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.
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": "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": "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": "Deletes the password policy for the AWS account.
", "DeleteGroup": "Deletes the specified group. The group must not contain any users or have any attached policies.
", "DeleteGroupPolicy": "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": "Deletes the specified instance profile. The instance profile must not have an associated role.
For more information about instance profiles, go to About Instance Profiles.
", "DeleteLoginProfile": "Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console.
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": "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:
For information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", "DeletePolicyVersion": "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": "Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.
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": "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.
Deletes the specified server certificate.
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.
", "DeleteUser": "Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.
", "DeleteUserPolicy": "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": "Deletes a virtual MFA device.
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": "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": "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": "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": "Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.
", "GetAccountAuthorizationDetails": "Retrieves information about all IAM users, groups, and roles in your account, including their relationships to one another and their policies. 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.
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
", "GetAccountSummary": "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": "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": " Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.
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": "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": " 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.
Returns information about the specified OpenID Connect provider.
", "GetPolicy": "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": "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": "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.
The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
", "GetRolePolicy": "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": "Returns the SAML provider metadocument that was uploaded when the provider was created or updated.
Retrieves information about the specified server certificate.
", "GetUser": "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": "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": "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.
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.
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.
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.
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.
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.
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.
Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
Lists the groups the specified user belongs to.
You can paginate the results using the MaxItems and Marker parameters.
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.
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.
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.
Lists information about the OpenID Connect providers in the AWS account.
", "ListPolicies": "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": "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": "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.
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.
The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
", "ListSAMLProviders": "Lists the SAML providers in the account.
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.
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.
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.
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.
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.
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.
PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. 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.
PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. 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.
PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. 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": "Removes the specified role from 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.
", "RemoveUserFromGroup": "Removes the specified user from the specified group.
", "ResyncMFADevice": "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": "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": "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": "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 Using IAM guide.
", "UpdateAssumeRolePolicy": "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": "Updates the name and/or the path of the specified group.
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": "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.
UpdateOpenIDConnectProviderThumbprint action to highly-privileged users. Updates the metadata document for an existing SAML provider.
Updates the name and/or the path of the specified server certificate.
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.
For information about rotating certificates, see Managing Keys and Certificates in the Using IAM guide.
", "UpdateUser": "Updates the name and/or the path of the specified user.
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.
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. 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.
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. 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.
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.
Signing Requests
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.
Recording API requests
IAM supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to IAM, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information, see the following:
Contains information about an AWS access key.
This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.
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. Information about the access key.
" } }, "AccessKeyMetadata": { "base": "Contains information about an AWS access key, without its secret key.
This data type is used as a response element in the ListAccessKeys action.
", "refs": { "accessKeyMetadataListType$member": null } }, "AddClientIDToOpenIDConnectProviderRequest": { "base": null, "refs": { } }, "AddRoleToInstanceProfileRequest": { "base": null, "refs": { } }, "AddUserToGroupRequest": { "base": null, "refs": { } }, "AttachGroupPolicyRequest": { "base": null, "refs": { } }, "AttachRolePolicyRequest": { "base": null, "refs": { } }, "AttachUserPolicyRequest": { "base": null, "refs": { } }, "AttachedPolicy": { "base": "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.
", "refs": { "attachedPoliciesListType$member": null } }, "BootstrapDatum": { "base": null, "refs": { "VirtualMFADevice$Base32StringSeed": " The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments, AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in Base32 format. The Base32String value is Base64-encoded.
Contains the response to a successful CreateAccessKey request.
", "refs": { } }, "CreateAccountAliasRequest": { "base": null, "refs": { } }, "CreateGroupRequest": { "base": null, "refs": { } }, "CreateGroupResponse": { "base": "Contains the response to a successful CreateGroup request.
", "refs": { } }, "CreateInstanceProfileRequest": { "base": null, "refs": { } }, "CreateInstanceProfileResponse": { "base": "Contains the response to a successful CreateInstanceProfile request.
", "refs": { } }, "CreateLoginProfileRequest": { "base": null, "refs": { } }, "CreateLoginProfileResponse": { "base": "Contains the response to a successful CreateLoginProfile request.
", "refs": { } }, "CreateOpenIDConnectProviderRequest": { "base": null, "refs": { } }, "CreateOpenIDConnectProviderResponse": { "base": "Contains the response to a successful CreateOpenIDConnectProvider request.
", "refs": { } }, "CreatePolicyRequest": { "base": null, "refs": { } }, "CreatePolicyResponse": { "base": "Contains the response to a successful CreatePolicy request.
", "refs": { } }, "CreatePolicyVersionRequest": { "base": null, "refs": { } }, "CreatePolicyVersionResponse": { "base": "Contains the response to a successful CreatePolicyVersion request.
", "refs": { } }, "CreateRoleRequest": { "base": null, "refs": { } }, "CreateRoleResponse": { "base": "Contains the response to a successful CreateRole request.
", "refs": { } }, "CreateSAMLProviderRequest": { "base": null, "refs": { } }, "CreateSAMLProviderResponse": { "base": "Contains the response to a successful CreateSAMLProvider request.
", "refs": { } }, "CreateUserRequest": { "base": null, "refs": { } }, "CreateUserResponse": { "base": "Contains the response to a successful CreateUser request.
", "refs": { } }, "CreateVirtualMFADeviceRequest": { "base": null, "refs": { } }, "CreateVirtualMFADeviceResponse": { "base": "Contains the response to a successful CreateVirtualMFADevice request.
", "refs": { } }, "CredentialReportExpiredException": { "base": "The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the Using IAM guide.
", "refs": { } }, "CredentialReportNotPresentException": { "base": "The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
", "refs": { } }, "CredentialReportNotReadyException": { "base": "The request was rejected because the credential report is still being generated.
", "refs": { } }, "DeactivateMFADeviceRequest": { "base": null, "refs": { } }, "DeleteAccessKeyRequest": { "base": null, "refs": { } }, "DeleteAccountAliasRequest": { "base": null, "refs": { } }, "DeleteConflictException": { "base": "The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
", "refs": { } }, "DeleteGroupPolicyRequest": { "base": null, "refs": { } }, "DeleteGroupRequest": { "base": null, "refs": { } }, "DeleteInstanceProfileRequest": { "base": null, "refs": { } }, "DeleteLoginProfileRequest": { "base": null, "refs": { } }, "DeleteOpenIDConnectProviderRequest": { "base": null, "refs": { } }, "DeletePolicyRequest": { "base": null, "refs": { } }, "DeletePolicyVersionRequest": { "base": null, "refs": { } }, "DeleteRolePolicyRequest": { "base": null, "refs": { } }, "DeleteRoleRequest": { "base": null, "refs": { } }, "DeleteSAMLProviderRequest": { "base": null, "refs": { } }, "DeleteServerCertificateRequest": { "base": null, "refs": { } }, "DeleteSigningCertificateRequest": { "base": null, "refs": { } }, "DeleteUserPolicyRequest": { "base": null, "refs": { } }, "DeleteUserRequest": { "base": null, "refs": { } }, "DeleteVirtualMFADeviceRequest": { "base": null, "refs": { } }, "DetachGroupPolicyRequest": { "base": null, "refs": { } }, "DetachRolePolicyRequest": { "base": null, "refs": { } }, "DetachUserPolicyRequest": { "base": null, "refs": { } }, "DuplicateCertificateException": { "base": "The request was rejected because the same certificate is associated to another user under the account.
", "refs": { } }, "EnableMFADeviceRequest": { "base": null, "refs": { } }, "EntityAlreadyExistsException": { "base": "The request was rejected because it attempted to create a resource that already exists.
", "refs": { } }, "EntityTemporarilyUnmodifiableException": { "base": "The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
", "refs": { } }, "EntityType": { "base": null, "refs": { "ListEntitiesForPolicyRequest$EntityFilter": "The entity type to use for filtering the results.
For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.
Contains the response to a successful GenerateCredentialReport request.
", "refs": { } }, "GetAccountAuthorizationDetailsRequest": { "base": null, "refs": { } }, "GetAccountAuthorizationDetailsResponse": { "base": "Contains the response to a successful GetAccountAuthorizationDetails request.
", "refs": { } }, "GetAccountPasswordPolicyResponse": { "base": "Contains the response to a successful GetAccountPasswordPolicy request.
", "refs": { } }, "GetAccountSummaryResponse": { "base": "Contains the response to a successful GetAccountSummary request.
", "refs": { } }, "GetCredentialReportResponse": { "base": "Contains the response to a successful GetCredentialReport request.
", "refs": { } }, "GetGroupPolicyRequest": { "base": null, "refs": { } }, "GetGroupPolicyResponse": { "base": "Contains the response to a successful GetGroupPolicy request.
", "refs": { } }, "GetGroupRequest": { "base": null, "refs": { } }, "GetGroupResponse": { "base": "Contains the response to a successful GetGroup request.
", "refs": { } }, "GetInstanceProfileRequest": { "base": null, "refs": { } }, "GetInstanceProfileResponse": { "base": "Contains the response to a successful GetInstanceProfile request.
", "refs": { } }, "GetLoginProfileRequest": { "base": null, "refs": { } }, "GetLoginProfileResponse": { "base": "Contains the response to a successful GetLoginProfile request.
", "refs": { } }, "GetOpenIDConnectProviderRequest": { "base": null, "refs": { } }, "GetOpenIDConnectProviderResponse": { "base": "Contains the response to a successful GetOpenIDConnectProvider request.
", "refs": { } }, "GetPolicyRequest": { "base": null, "refs": { } }, "GetPolicyResponse": { "base": "Contains the response to a successful GetPolicy request.
", "refs": { } }, "GetPolicyVersionRequest": { "base": null, "refs": { } }, "GetPolicyVersionResponse": { "base": "Contains the response to a successful GetPolicyVersion request.
", "refs": { } }, "GetRolePolicyRequest": { "base": null, "refs": { } }, "GetRolePolicyResponse": { "base": "Contains the response to a successful GetRolePolicy request.
", "refs": { } }, "GetRoleRequest": { "base": null, "refs": { } }, "GetRoleResponse": { "base": "Contains the response to a successful GetRole request.
", "refs": { } }, "GetSAMLProviderRequest": { "base": null, "refs": { } }, "GetSAMLProviderResponse": { "base": "Contains the response to a successful GetSAMLProvider request.
", "refs": { } }, "GetServerCertificateRequest": { "base": null, "refs": { } }, "GetServerCertificateResponse": { "base": "Contains the response to a successful GetServerCertificate request.
", "refs": { } }, "GetUserPolicyRequest": { "base": null, "refs": { } }, "GetUserPolicyResponse": { "base": "Contains the response to a successful GetUserPolicy request.
", "refs": { } }, "GetUserRequest": { "base": null, "refs": { } }, "GetUserResponse": { "base": "Contains the response to a successful GetUser request.
", "refs": { } }, "Group": { "base": "Contains information about an IAM group entity.
This data type is used as a response element in the following actions:
", "refs": { "CreateGroupResponse$Group": "Information about the group.
", "GetGroupResponse$Group": "Information about the group.
", "groupListType$member": null } }, "GroupDetail": { "base": "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.
", "refs": { "groupDetailListType$member": null } }, "InstanceProfile": { "base": "Contains information about an instance profile.
This data type is used as a response element in the following actions:
", "refs": { "CreateInstanceProfileResponse$InstanceProfile": "Information about the instance profile.
", "GetInstanceProfileResponse$InstanceProfile": "Information about the instance profile.
", "instanceProfileListType$member": null } }, "InvalidAuthenticationCodeException": { "base": "The request was rejected because the authentication code was not recognized. The error message describes the specific error.
", "refs": { } }, "InvalidCertificateException": { "base": "The request was rejected because the certificate is invalid.
", "refs": { } }, "InvalidInputException": { "base": "The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
", "refs": { } }, "InvalidUserTypeException": { "base": "The request was rejected because the type of user for the transaction was incorrect.
", "refs": { } }, "KeyPairMismatchException": { "base": "The request was rejected because the public key certificate and the private key do not match.
", "refs": { } }, "LimitExceededException": { "base": "The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
", "refs": { } }, "ListAccessKeysRequest": { "base": null, "refs": { } }, "ListAccessKeysResponse": { "base": "Contains the response to a successful ListAccessKeys request.
", "refs": { } }, "ListAccountAliasesRequest": { "base": null, "refs": { } }, "ListAccountAliasesResponse": { "base": "Contains the response to a successful ListAccountAliases request.
", "refs": { } }, "ListAttachedGroupPoliciesRequest": { "base": null, "refs": { } }, "ListAttachedGroupPoliciesResponse": { "base": "Contains the response to a successful ListAttachedGroupPolicies request.
", "refs": { } }, "ListAttachedRolePoliciesRequest": { "base": null, "refs": { } }, "ListAttachedRolePoliciesResponse": { "base": "Contains the response to a successful ListAttachedRolePolicies request.
", "refs": { } }, "ListAttachedUserPoliciesRequest": { "base": null, "refs": { } }, "ListAttachedUserPoliciesResponse": { "base": "Contains the response to a successful ListAttachedUserPolicies request.
", "refs": { } }, "ListEntitiesForPolicyRequest": { "base": null, "refs": { } }, "ListEntitiesForPolicyResponse": { "base": "Contains the response to a successful ListEntitiesForPolicy request.
", "refs": { } }, "ListGroupPoliciesRequest": { "base": null, "refs": { } }, "ListGroupPoliciesResponse": { "base": "Contains the response to a successful ListGroupPolicies request.
", "refs": { } }, "ListGroupsForUserRequest": { "base": null, "refs": { } }, "ListGroupsForUserResponse": { "base": "Contains the response to a successful ListGroupsForUser request.
", "refs": { } }, "ListGroupsRequest": { "base": null, "refs": { } }, "ListGroupsResponse": { "base": "Contains the response to a successful ListGroups request.
", "refs": { } }, "ListInstanceProfilesForRoleRequest": { "base": null, "refs": { } }, "ListInstanceProfilesForRoleResponse": { "base": "Contains the response to a successful ListInstanceProfilesForRole request.
", "refs": { } }, "ListInstanceProfilesRequest": { "base": null, "refs": { } }, "ListInstanceProfilesResponse": { "base": "Contains the response to a successful ListInstanceProfiles request.
", "refs": { } }, "ListMFADevicesRequest": { "base": null, "refs": { } }, "ListMFADevicesResponse": { "base": "Contains the response to a successful ListMFADevices request.
", "refs": { } }, "ListOpenIDConnectProvidersRequest": { "base": null, "refs": { } }, "ListOpenIDConnectProvidersResponse": { "base": "Contains the response to a successful ListOpenIDConnectProviders request.
", "refs": { } }, "ListPoliciesRequest": { "base": null, "refs": { } }, "ListPoliciesResponse": { "base": "Contains the response to a successful ListPolicies request.
", "refs": { } }, "ListPolicyVersionsRequest": { "base": null, "refs": { } }, "ListPolicyVersionsResponse": { "base": "Contains the response to a successful ListPolicyVersions request.
", "refs": { } }, "ListRolePoliciesRequest": { "base": null, "refs": { } }, "ListRolePoliciesResponse": { "base": "Contains the response to a successful ListRolePolicies request.
", "refs": { } }, "ListRolesRequest": { "base": null, "refs": { } }, "ListRolesResponse": { "base": "Contains the response to a successful ListRoles request.
", "refs": { } }, "ListSAMLProvidersRequest": { "base": null, "refs": { } }, "ListSAMLProvidersResponse": { "base": "Contains the response to a successful ListSAMLProviders request.
", "refs": { } }, "ListServerCertificatesRequest": { "base": null, "refs": { } }, "ListServerCertificatesResponse": { "base": "Contains the response to a successful ListServerCertificates request.
", "refs": { } }, "ListSigningCertificatesRequest": { "base": null, "refs": { } }, "ListSigningCertificatesResponse": { "base": "Contains the response to a successful ListSigningCertificates request.
", "refs": { } }, "ListUserPoliciesRequest": { "base": null, "refs": { } }, "ListUserPoliciesResponse": { "base": "Contains the response to a successful ListUserPolicies request.
", "refs": { } }, "ListUsersRequest": { "base": null, "refs": { } }, "ListUsersResponse": { "base": "Contains the response to a successful ListUsers request.
", "refs": { } }, "ListVirtualMFADevicesRequest": { "base": null, "refs": { } }, "ListVirtualMFADevicesResponse": { "base": "Contains the response to a successful ListVirtualMFADevices request.
", "refs": { } }, "LoginProfile": { "base": "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.
", "refs": { "CreateLoginProfileResponse$LoginProfile": "The user name and password create date.
", "GetLoginProfileResponse$LoginProfile": "The user name and password create date for the user.
" } }, "MFADevice": { "base": "Contains information about an MFA device.
This data type is used as a response element in the ListMFADevices action.
", "refs": { "mfaDeviceListType$member": null } }, "MalformedCertificateException": { "base": "The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
", "refs": { } }, "MalformedPolicyDocumentException": { "base": "The request was rejected because the policy document was malformed. The error message describes the specific error.
", "refs": { } }, "ManagedPolicyDetail": { "base": "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.
", "refs": { "ManagedPolicyDetailListType$member": null } }, "ManagedPolicyDetailListType": { "base": null, "refs": { "GetAccountAuthorizationDetailsResponse$Policies": "A list containing information about managed policies.
" } }, "NoSuchEntityException": { "base": "The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
", "refs": { } }, "OpenIDConnectProviderListEntry": { "base": "Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.
", "refs": { "OpenIDConnectProviderListType$member": null } }, "OpenIDConnectProviderListType": { "base": "Contains a list of IAM OpenID Connect providers.
", "refs": { "ListOpenIDConnectProvidersResponse$OpenIDConnectProviderList": "The list of IAM OpenID Connect providers in the AWS account.
" } }, "OpenIDConnectProviderUrlType": { "base": "Contains a URL that specifies the endpoint for an OpenID Connect provider.
", "refs": { "CreateOpenIDConnectProviderRequest$Url": "The URL of the identity provider. The URL must begin with \"https://\" and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a host name, like \"https://server.example.org\" or \"https://example.com\".
You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
", "GetOpenIDConnectProviderResponse$Url": "The URL that the IAM OpenID Connect provider is associated with. For more information, see CreateOpenIDConnectProvider.
" } }, "PasswordPolicy": { "base": "Contains information about the account password policy.
This data type is used as a response element in the GetAccountPasswordPolicy action.
", "refs": { "GetAccountPasswordPolicyResponse$PasswordPolicy": null } }, "PasswordPolicyViolationException": { "base": "The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
", "refs": { } }, "Policy": { "base": "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.
", "refs": { "CreatePolicyResponse$Policy": "Information about the policy.
", "GetPolicyResponse$Policy": "Information about the policy.
", "policyListType$member": null } }, "PolicyDetail": { "base": "Contains information about an IAM policy, including the policy document.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
", "refs": { "policyDetailListType$member": null } }, "PolicyGroup": { "base": "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.
", "refs": { "PolicyGroupListType$member": null } }, "PolicyGroupListType": { "base": null, "refs": { "ListEntitiesForPolicyResponse$PolicyGroups": "A list of groups that the policy is attached to.
" } }, "PolicyRole": { "base": "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.
", "refs": { "PolicyRoleListType$member": null } }, "PolicyRoleListType": { "base": null, "refs": { "ListEntitiesForPolicyResponse$PolicyRoles": "A list of roles that the policy is attached to.
" } }, "PolicyUser": { "base": "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.
", "refs": { "PolicyUserListType$member": null } }, "PolicyUserListType": { "base": null, "refs": { "ListEntitiesForPolicyResponse$PolicyUsers": "A list of users that the policy is attached to.
" } }, "PolicyVersion": { "base": "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.
", "refs": { "CreatePolicyVersionResponse$PolicyVersion": "Information about the policy version.
", "GetPolicyVersionResponse$PolicyVersion": "Information about the policy version.
For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.
", "policyDocumentVersionListType$member": null } }, "PutGroupPolicyRequest": { "base": null, "refs": { } }, "PutRolePolicyRequest": { "base": null, "refs": { } }, "PutUserPolicyRequest": { "base": null, "refs": { } }, "RemoveClientIDFromOpenIDConnectProviderRequest": { "base": null, "refs": { } }, "RemoveRoleFromInstanceProfileRequest": { "base": null, "refs": { } }, "RemoveUserFromGroupRequest": { "base": null, "refs": { } }, "ReportContentType": { "base": null, "refs": { "GetCredentialReportResponse$Content": "Contains the credential report. The report is Base64-encoded.
" } }, "ReportFormatType": { "base": null, "refs": { "GetCredentialReportResponse$ReportFormat": "The format (MIME type) of the credential report.
" } }, "ReportStateDescriptionType": { "base": null, "refs": { "GenerateCredentialReportResponse$Description": "Information about the credential report.
" } }, "ReportStateType": { "base": null, "refs": { "GenerateCredentialReportResponse$State": "Information about the state of the credential report.
" } }, "ResyncMFADeviceRequest": { "base": null, "refs": { } }, "Role": { "base": "Contains information about an IAM role.
This data type is used as a response element in the following actions:
", "refs": { "CreateRoleResponse$Role": "Information about the role.
", "GetRoleResponse$Role": "Information about the role.
", "roleListType$member": null } }, "RoleDetail": { "base": "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.
", "refs": { "roleDetailListType$member": null } }, "SAMLMetadataDocumentType": { "base": null, "refs": { "CreateSAMLProviderRequest$SAMLMetadataDocument": "An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document 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.
For more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary Security Credentials guide.
", "GetSAMLProviderResponse$SAMLMetadataDocument": "The XML metadata document that includes information about an identity provider.
", "UpdateSAMLProviderRequest$SAMLMetadataDocument": "An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document 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.
" } }, "SAMLProviderListEntry": { "base": "Contains the list of SAML providers for this account.
", "refs": { "SAMLProviderListType$member": null } }, "SAMLProviderListType": { "base": null, "refs": { "ListSAMLProvidersResponse$SAMLProviderList": "The list of SAML providers for this account.
" } }, "SAMLProviderNameType": { "base": null, "refs": { "CreateSAMLProviderRequest$Name": "The name of the provider to create.
" } }, "ServerCertificate": { "base": "Contains information about a server certificate.
This data type is used as a response element in the GetServerCertificate action.
", "refs": { "GetServerCertificateResponse$ServerCertificate": "Information about the server certificate.
" } }, "ServerCertificateMetadata": { "base": "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.
", "refs": { "ServerCertificate$ServerCertificateMetadata": "The meta information of the server certificate, such as its name, path, ID, and ARN.
", "UploadServerCertificateResponse$ServerCertificateMetadata": "The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
", "serverCertificateMetadataListType$member": null } }, "ServiceFailureException": { "base": "The request processing has failed because of an unknown error, exception or failure.
", "refs": { } }, "SetDefaultPolicyVersionRequest": { "base": null, "refs": { } }, "SigningCertificate": { "base": "Contains information about an X.509 signing certificate.
This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.
", "refs": { "UploadSigningCertificateResponse$Certificate": "Information about the certificate.
", "certificateListType$member": null } }, "UpdateAccessKeyRequest": { "base": null, "refs": { } }, "UpdateAccountPasswordPolicyRequest": { "base": null, "refs": { } }, "UpdateAssumeRolePolicyRequest": { "base": null, "refs": { } }, "UpdateGroupRequest": { "base": null, "refs": { } }, "UpdateLoginProfileRequest": { "base": null, "refs": { } }, "UpdateOpenIDConnectProviderThumbprintRequest": { "base": null, "refs": { } }, "UpdateSAMLProviderRequest": { "base": null, "refs": { } }, "UpdateSAMLProviderResponse": { "base": "Contains the response to a successful UpdateSAMLProvider request.
", "refs": { } }, "UpdateServerCertificateRequest": { "base": null, "refs": { } }, "UpdateSigningCertificateRequest": { "base": null, "refs": { } }, "UpdateUserRequest": { "base": null, "refs": { } }, "UploadServerCertificateRequest": { "base": null, "refs": { } }, "UploadServerCertificateResponse": { "base": "Contains the response to a successful UploadServerCertificate request.
", "refs": { } }, "UploadSigningCertificateRequest": { "base": null, "refs": { } }, "UploadSigningCertificateResponse": { "base": "Contains the response to a successful UploadSigningCertificate request.
", "refs": { } }, "User": { "base": "Contains information about an IAM user entity.
This data type is used as a response element in the following actions:
", "refs": { "CreateUserResponse$User": "Information about the user.
", "GetUserResponse$User": "Information about the user.
", "VirtualMFADevice$User": null, "userListType$member": null } }, "UserDetail": { "base": "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.
", "refs": { "userDetailListType$member": null } }, "VirtualMFADevice": { "base": "Contains information about a virtual MFA device.
", "refs": { "CreateVirtualMFADeviceResponse$VirtualMFADevice": "A newly created virtual MFA device.
", "virtualMFADeviceListType$member": null } }, "accessKeyIdType": { "base": null, "refs": { "AccessKey$AccessKeyId": "The ID for this access key.
", "AccessKeyMetadata$AccessKeyId": "The ID for this access key.
", "DeleteAccessKeyRequest$AccessKeyId": "The access key ID for the access key ID and secret access key you want to delete.
", "UpdateAccessKeyRequest$AccessKeyId": "The access key ID of the secret access key you want to update.
" } }, "accessKeyMetadataListType": { "base": "Contains a list of access key metadata.
This data type is used as a response element in the ListAccessKeys action.
", "refs": { "ListAccessKeysResponse$AccessKeyMetadata": "A list of access key metadata.
" } }, "accessKeySecretType": { "base": null, "refs": { "AccessKey$SecretAccessKey": "The secret key used to sign requests.
" } }, "accountAliasListType": { "base": null, "refs": { "ListAccountAliasesResponse$AccountAliases": "A list of aliases associated with the account.
" } }, "accountAliasType": { "base": null, "refs": { "CreateAccountAliasRequest$AccountAlias": "The account alias to create.
", "DeleteAccountAliasRequest$AccountAlias": "The name of the account alias to delete.
", "accountAliasListType$member": null } }, "arnType": { "base": "The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", "refs": { "AddClientIDToOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
", "AttachGroupPolicyRequest$PolicyArn": null, "AttachRolePolicyRequest$PolicyArn": null, "AttachUserPolicyRequest$PolicyArn": null, "AttachedPolicy$PolicyArn": null, "CreateOpenIDConnectProviderResponse$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect provider that was created. For more information, see OpenIDConnectProviderListEntry.
", "CreatePolicyVersionRequest$PolicyArn": null, "CreateSAMLProviderResponse$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider.
", "DeleteOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect provider to delete. You can get a list of OpenID Connect provider ARNs by using the ListOpenIDConnectProviders action.
", "DeletePolicyRequest$PolicyArn": null, "DeletePolicyVersionRequest$PolicyArn": null, "DeleteSAMLProviderRequest$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider to delete.
", "DetachGroupPolicyRequest$PolicyArn": null, "DetachRolePolicyRequest$PolicyArn": null, "DetachUserPolicyRequest$PolicyArn": null, "GetOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to get information for. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
", "GetPolicyRequest$PolicyArn": null, "GetPolicyVersionRequest$PolicyArn": null, "GetSAMLProviderRequest$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider to get information about.
", "Group$Arn": "The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", "GroupDetail$Arn": null, "InstanceProfile$Arn": "The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", "ListEntitiesForPolicyRequest$PolicyArn": null, "ListPolicyVersionsRequest$PolicyArn": null, "ManagedPolicyDetail$Arn": null, "OpenIDConnectProviderListEntry$Arn": null, "Policy$Arn": null, "RemoveClientIDFromOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
", "Role$Arn": "The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", "RoleDetail$Arn": null, "SAMLProviderListEntry$Arn": "The Amazon Resource Name (ARN) of the SAML provider.
", "ServerCertificateMetadata$Arn": "The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", "SetDefaultPolicyVersionRequest$PolicyArn": null, "UpdateOpenIDConnectProviderThumbprintRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to update the thumbprint for. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
", "UpdateSAMLProviderRequest$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider to update.
", "UpdateSAMLProviderResponse$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider that was updated.
", "User$Arn": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.
", "UserDetail$Arn": null } }, "assignmentStatusType": { "base": null, "refs": { "ListVirtualMFADevicesRequest$AssignmentStatus": " The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.
A list of the managed policies attached to the group.
", "ListAttachedGroupPoliciesResponse$AttachedPolicies": "A list of the attached policies.
", "ListAttachedRolePoliciesResponse$AttachedPolicies": "A list of the attached policies.
", "ListAttachedUserPoliciesResponse$AttachedPolicies": "A list of the attached policies.
", "RoleDetail$AttachedManagedPolicies": "A list of managed policies attached to the role. These policies are the role's access (permissions) policies.
", "UserDetail$AttachedManagedPolicies": "A list of the managed policies attached to the user.
" } }, "attachmentCountType": { "base": null, "refs": { "ManagedPolicyDetail$AttachmentCount": "The number of principal entities (users, groups, and roles) that the policy is attached to.
", "Policy$AttachmentCount": "The number of entities (users, groups, and roles) that the policy is attached to.
" } }, "authenticationCodeType": { "base": null, "refs": { "EnableMFADeviceRequest$AuthenticationCode1": "An authentication code emitted by the device.
", "EnableMFADeviceRequest$AuthenticationCode2": "A subsequent authentication code emitted by the device.
", "ResyncMFADeviceRequest$AuthenticationCode1": "An authentication code emitted by the device.
", "ResyncMFADeviceRequest$AuthenticationCode2": "A subsequent authentication code emitted by the device.
" } }, "booleanObjectType": { "base": null, "refs": { "PasswordPolicy$HardExpiry": "Specifies whether IAM users are prevented from setting a new password after their password has expired.
", "UpdateAccountPasswordPolicyRequest$HardExpiry": "Prevents IAM users from setting a new password after their password has expired.
Default value: false
", "UpdateLoginProfileRequest$PasswordResetRequired": "Require the specified user to set a new password on next sign-in.
" } }, "booleanType": { "base": null, "refs": { "CreateLoginProfileRequest$PasswordResetRequired": "Specifies whether the user is required to set a new password on next sign-in.
", "CreatePolicyVersionRequest$SetAsDefault": "Specifies whether to set this version as the policy's default version.
When this parameter is true, the new policy version becomes 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.
", "GetAccountAuthorizationDetailsResponse$IsTruncated": "A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.
A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more user names in the list.
A flag that indicates whether there are more keys to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more keys in the list.
A flag that indicates whether there are more account aliases to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more account aliases in the list.
A flag that indicates whether there are more policies to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policies in the list.
A flag that indicates whether there are more policies to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policies in the list.
A flag that indicates whether there are more policies to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policies in the list.
A flag that indicates whether there are more entities to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more entities in the list.
A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.
A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.
A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.
A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.
A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.
A flag that indicates whether there are more MFA devices to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more MFA devices in the list.
A flag to filter the results to only the attached policies.
When OnlyAttached is true, the returned list contains only the policies that are attached to a user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.
A flag that indicates whether there are more policies to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policies in the list.
A flag that indicates whether there are more policy versions to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy versions in the list.
A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.
A flag that indicates whether there are more roles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more roles in the list.
A flag that indicates whether there are more server certificates to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more server certificates in the list.
A flag that indicates whether there are more certificate IDs to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more certificates in the list.
A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.
A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more users in the list.
A flag that indicates whether there are more items to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items the list.
Specifies whether the user is required to set a new password on next sign-in.
", "ManagedPolicyDetail$IsAttachable": "Specifies whether the policy can be attached to an IAM user, group, or role.
", "PasswordPolicy$RequireSymbols": "Specifies whether to require symbols for IAM user passwords.
", "PasswordPolicy$RequireNumbers": "Specifies whether to require numbers for IAM user passwords.
", "PasswordPolicy$RequireUppercaseCharacters": "Specifies whether to require uppercase characters for IAM user passwords.
", "PasswordPolicy$RequireLowercaseCharacters": "Specifies whether to require lowercase characters for IAM user passwords.
", "PasswordPolicy$AllowUsersToChangePassword": "Specifies whether IAM users are allowed to change their own password.
", "PasswordPolicy$ExpirePasswords": "Specifies whether IAM users are required to change their password after a specified number of days.
", "Policy$IsAttachable": "Specifies whether the policy can be attached to an IAM user, group, or role.
", "PolicyVersion$IsDefaultVersion": "Specifies whether the policy version is set as the policy's default version.
", "UpdateAccountPasswordPolicyRequest$RequireSymbols": "Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
Default value: false
", "UpdateAccountPasswordPolicyRequest$RequireNumbers": "Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
Default value: false
", "UpdateAccountPasswordPolicyRequest$RequireUppercaseCharacters": "Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
Default value: false
", "UpdateAccountPasswordPolicyRequest$RequireLowercaseCharacters": "Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
Default value: false
", "UpdateAccountPasswordPolicyRequest$AllowUsersToChangePassword": "Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the Using IAM guide.
Default value: false
" } }, "certificateBodyType": { "base": null, "refs": { "ServerCertificate$CertificateBody": "The contents of the public key certificate.
", "SigningCertificate$CertificateBody": "The contents of the signing certificate.
", "UploadServerCertificateRequest$CertificateBody": "The contents of the public key certificate in PEM-encoded format.
", "UploadSigningCertificateRequest$CertificateBody": "The contents of the signing certificate.
" } }, "certificateChainType": { "base": null, "refs": { "ServerCertificate$CertificateChain": "The contents of the public key certificate chain.
", "UploadServerCertificateRequest$CertificateChain": "The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
" } }, "certificateIdType": { "base": null, "refs": { "DeleteSigningCertificateRequest$CertificateId": "The ID of the signing certificate to delete.
", "SigningCertificate$CertificateId": "The ID for the signing certificate.
", "UpdateSigningCertificateRequest$CertificateId": "The ID of the signing certificate you want to update.
" } }, "certificateListType": { "base": "Contains a list of signing certificates.
This data type is used as a response element in the ListSigningCertificates action.
", "refs": { "ListSigningCertificatesResponse$Certificates": "A list of the user's signing certificate information.
" } }, "clientIDListType": { "base": null, "refs": { "CreateOpenIDConnectProviderRequest$ClientIDList": "A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest action accepts client IDs up to 255 characters long.
A list of client IDs (also known as audiences) that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
" } }, "clientIDType": { "base": null, "refs": { "AddClientIDToOpenIDConnectProviderRequest$ClientID": "The client ID (also known as audience) to add to the IAM OpenID Connect provider.
", "RemoveClientIDFromOpenIDConnectProviderRequest$ClientID": "The client ID (also known as audience) to remove from the IAM OpenID Connect provider. For more information about client IDs, see CreateOpenIDConnectProvider.
", "clientIDListType$member": null } }, "credentialReportExpiredExceptionMessage": { "base": null, "refs": { "CredentialReportExpiredException$message": null } }, "credentialReportNotPresentExceptionMessage": { "base": null, "refs": { "CredentialReportNotPresentException$message": null } }, "credentialReportNotReadyExceptionMessage": { "base": null, "refs": { "CredentialReportNotReadyException$message": null } }, "dateType": { "base": null, "refs": { "AccessKey$CreateDate": "The date when the access key was created.
", "AccessKeyMetadata$CreateDate": "The date when the access key was created.
", "GetCredentialReportResponse$GeneratedTime": "The date and time when the credential report was created, in ISO 8601 date-time format.
", "GetOpenIDConnectProviderResponse$CreateDate": "The date and time when the IAM OpenID Connect provider entity was created in the AWS account.
", "GetSAMLProviderResponse$CreateDate": "The date and time when the SAML provider was created.
", "GetSAMLProviderResponse$ValidUntil": "The expiration date and time for the SAML provider.
", "Group$CreateDate": "The date and time, in ISO 8601 date-time format, when the group was created.
", "GroupDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the group was created.
", "InstanceProfile$CreateDate": "The date when the instance profile was created.
", "LoginProfile$CreateDate": "The date when the password for the user was created.
", "MFADevice$EnableDate": "The date when the MFA device was enabled for the user.
", "ManagedPolicyDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the policy was created.
", "ManagedPolicyDetail$UpdateDate": "The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
", "Policy$CreateDate": "The date and time, in ISO 8601 date-time format, when the policy was created.
", "Policy$UpdateDate": "The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
", "PolicyVersion$CreateDate": "The date and time, in ISO 8601 date-time format, when the policy version was created.
", "Role$CreateDate": "The date and time, in ISO 8601 date-time format, when the role was created.
", "RoleDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the role was created.
", "SAMLProviderListEntry$ValidUntil": "The expiration date and time for the SAML provider.
", "SAMLProviderListEntry$CreateDate": "The date and time when the SAML provider was created.
", "ServerCertificateMetadata$UploadDate": "The date when the server certificate was uploaded.
", "ServerCertificateMetadata$Expiration": "The date on which the certificate is set to expire.
", "SigningCertificate$UploadDate": "The date when the signing certificate was uploaded.
", "User$CreateDate": "The date and time, in ISO 8601 date-time format, when the user was created.
", "User$PasswordLastUsed": "The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. When the user does not have a password, this field is null (not present). When a user's password exists but has never been used, or when there is no sign-in data associated with the user, this field is null (not present).
This value is returned only in the GetUser and ListUsers actions.
", "UserDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the user was created.
", "VirtualMFADevice$EnableDate": "The date and time on which the virtual MFA device was enabled.
" } }, "deleteConflictMessage": { "base": null, "refs": { "DeleteConflictException$message": null } }, "duplicateCertificateMessage": { "base": null, "refs": { "DuplicateCertificateException$message": null } }, "entityAlreadyExistsMessage": { "base": null, "refs": { "EntityAlreadyExistsException$message": null } }, "entityListType": { "base": null, "refs": { "GetAccountAuthorizationDetailsRequest$Filter": "A list of entity types (user, group, role, local managed policy, or AWS managed policy) for filtering the results.
" } }, "entityTemporarilyUnmodifiableMessage": { "base": null, "refs": { "EntityTemporarilyUnmodifiableException$message": null } }, "existingUserNameType": { "base": null, "refs": { "AddUserToGroupRequest$UserName": "The name of the user to add.
", "CreateAccessKeyRequest$UserName": "The user name that the new key will belong to.
", "DeactivateMFADeviceRequest$UserName": "The name of the user whose MFA device you want to deactivate.
", "DeleteAccessKeyRequest$UserName": "The name of the user whose key you want to delete.
", "DeleteSigningCertificateRequest$UserName": "The name of the user the signing certificate belongs to.
", "DeleteUserPolicyRequest$UserName": "The name (friendly name, not ARN) identifying the user that the policy is embedded in.
", "DeleteUserRequest$UserName": "The name of the user to delete.
", "EnableMFADeviceRequest$UserName": "The name of the user for whom you want to enable the MFA device.
", "GetUserPolicyRequest$UserName": "The name of the user who the policy is associated with.
", "GetUserPolicyResponse$UserName": "The user the policy is associated with.
", "GetUserRequest$UserName": "The name of the user to get information about.
This parameter is optional. If it is not included, it defaults to the user making the request.
", "ListAccessKeysRequest$UserName": "The name of the user.
", "ListGroupsForUserRequest$UserName": "The name of the user to list groups for.
", "ListMFADevicesRequest$UserName": "The name of the user whose MFA devices you want to list.
", "ListSigningCertificatesRequest$UserName": "The name of the user.
", "ListUserPoliciesRequest$UserName": "The name of the user to list policies for.
", "PutUserPolicyRequest$UserName": "The name of the user to associate the policy with.
", "RemoveUserFromGroupRequest$UserName": "The name of the user to remove.
", "ResyncMFADeviceRequest$UserName": "The name of the user whose MFA device you want to resynchronize.
", "UpdateAccessKeyRequest$UserName": "The name of the user whose key you want to update.
", "UpdateSigningCertificateRequest$UserName": "The name of the user the signing certificate belongs to.
", "UpdateUserRequest$UserName": "Name of the user to update. If you're changing the name of the user, this is the original user name.
", "UploadSigningCertificateRequest$UserName": "The name of the user the signing certificate is for.
" } }, "groupDetailListType": { "base": null, "refs": { "GetAccountAuthorizationDetailsResponse$GroupDetailList": "A list containing information about IAM groups.
" } }, "groupListType": { "base": "Contains a list of IAM groups.
This data type is used as a response element in the ListGroups action.
", "refs": { "ListGroupsForUserResponse$Groups": "A list of groups.
", "ListGroupsResponse$Groups": "A list of groups.
" } }, "groupNameListType": { "base": null, "refs": { "UserDetail$GroupList": "A list of IAM groups that the user is in.
" } }, "groupNameType": { "base": null, "refs": { "AddUserToGroupRequest$GroupName": "The name of the group to update.
", "AttachGroupPolicyRequest$GroupName": "The name (friendly name, not ARN) of the group to attach the policy to.
", "CreateGroupRequest$GroupName": "The name of the group to create. Do not include the path in this value.
", "DeleteGroupPolicyRequest$GroupName": "The name (friendly name, not ARN) identifying the group that the policy is embedded in.
", "DeleteGroupRequest$GroupName": "The name of the group to delete.
", "DetachGroupPolicyRequest$GroupName": "The name (friendly name, not ARN) of the group to detach the policy from.
", "GetGroupPolicyRequest$GroupName": "The name of the group the policy is associated with.
", "GetGroupPolicyResponse$GroupName": "The group the policy is associated with.
", "GetGroupRequest$GroupName": "The name of the group.
", "Group$GroupName": "The friendly name that identifies the group.
", "GroupDetail$GroupName": "The friendly name that identifies the group.
", "ListAttachedGroupPoliciesRequest$GroupName": "The name (friendly name, not ARN) of the group to list attached policies for.
", "ListGroupPoliciesRequest$GroupName": "The name of the group to list policies for.
", "PolicyGroup$GroupName": "The name (friendly name, not ARN) identifying the group.
", "PutGroupPolicyRequest$GroupName": "The name of the group to associate the policy with.
", "RemoveUserFromGroupRequest$GroupName": "The name of the group to update.
", "UpdateGroupRequest$GroupName": "Name of the group to update. If you're changing the name of the group, this is the original name.
", "UpdateGroupRequest$NewGroupName": "New name for the group. Only include this if changing the group's name.
", "groupNameListType$member": null } }, "idType": { "base": null, "refs": { "Group$GroupId": "The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "GroupDetail$GroupId": "The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "InstanceProfile$InstanceProfileId": "The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "ManagedPolicyDetail$PolicyId": "The stable and unique string identifying the policy.
For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "Policy$PolicyId": "The stable and unique string identifying the policy.
For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "Role$RoleId": "The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "RoleDetail$RoleId": "The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "ServerCertificateMetadata$ServerCertificateId": "The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "User$UserId": "The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", "UserDetail$UserId": "The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" } }, "instanceProfileListType": { "base": "Contains a list of instance profiles.
", "refs": { "ListInstanceProfilesForRoleResponse$InstanceProfiles": "A list of instance profiles.
", "ListInstanceProfilesResponse$InstanceProfiles": "A list of instance profiles.
", "RoleDetail$InstanceProfileList": null } }, "instanceProfileNameType": { "base": null, "refs": { "AddRoleToInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to update.
", "CreateInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to create.
", "DeleteInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to delete.
", "GetInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to get information about.
", "InstanceProfile$InstanceProfileName": "The name identifying the instance profile.
", "RemoveRoleFromInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to update.
" } }, "invalidAuthenticationCodeMessage": { "base": null, "refs": { "InvalidAuthenticationCodeException$message": null } }, "invalidCertificateMessage": { "base": null, "refs": { "InvalidCertificateException$message": null } }, "invalidInputMessage": { "base": null, "refs": { "InvalidInputException$message": null } }, "invalidUserTypeMessage": { "base": null, "refs": { "InvalidUserTypeException$message": null } }, "keyPairMismatchMessage": { "base": null, "refs": { "KeyPairMismatchException$message": null } }, "limitExceededMessage": { "base": null, "refs": { "LimitExceededException$message": null } }, "malformedCertificateMessage": { "base": null, "refs": { "MalformedCertificateException$message": null } }, "malformedPolicyDocumentMessage": { "base": null, "refs": { "MalformedPolicyDocumentException$message": null } }, "markerType": { "base": null, "refs": { "GetAccountAuthorizationDetailsRequest$Marker": "Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, then this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of keys you want in the response. If there are additional keys beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of account aliases you want in the response. If there are additional account aliases beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of instance profiles you want in the response. If there are additional instance profiles beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of instance profiles you want in the response. If there are additional instance profiles beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of policy versions you want in the response. If there are additional policy versions beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of role policies you want in the response. If there are additional role policies beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of roles you want in the response. If there are additional roles beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of server certificates you want in the response. If there are additional server certificates beyond the maximum you specify, the IsTruncated response element will be set to true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of certificate IDs you want in the response. If there are additional certificate IDs beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this parameter only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
The number of days that an IAM user password is valid.
", "UpdateAccountPasswordPolicyRequest$MaxPasswordAge": "The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.
Default value: 0
" } }, "mfaDeviceListType": { "base": "Contains a list of MFA devices.
This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices actions.
", "refs": { "ListMFADevicesResponse$MFADevices": "A list of MFA devices.
" } }, "minimumPasswordLengthType": { "base": null, "refs": { "PasswordPolicy$MinimumPasswordLength": "Minimum length to require for IAM user passwords.
", "UpdateAccountPasswordPolicyRequest$MinimumPasswordLength": "The minimum number of characters allowed in an IAM user password.
Default value: 6
" } }, "noSuchEntityMessage": { "base": null, "refs": { "NoSuchEntityException$message": null } }, "passwordPolicyViolationMessage": { "base": null, "refs": { "PasswordPolicyViolationException$message": null } }, "passwordReusePreventionType": { "base": null, "refs": { "PasswordPolicy$PasswordReusePrevention": "Specifies the number of previous passwords that IAM users are prevented from reusing.
", "UpdateAccountPasswordPolicyRequest$PasswordReusePrevention": "Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.
Default value: 0
" } }, "passwordType": { "base": null, "refs": { "ChangePasswordRequest$OldPassword": "The IAM user's current password.
", "ChangePasswordRequest$NewPassword": "The new password. The new password must conform to the AWS account's password policy, if one exists.
", "CreateLoginProfileRequest$Password": "The new password for the user.
", "UpdateLoginProfileRequest$Password": "The new password for the specified user.
" } }, "pathPrefixType": { "base": null, "refs": { "ListGroupsRequest$PathPrefix": " The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.
", "ListInstanceProfilesRequest$PathPrefix": " The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.
", "ListRolesRequest$PathPrefix": " The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.
", "ListServerCertificatesRequest$PathPrefix": " The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.
", "ListUsersRequest$PathPrefix": " The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.
" } }, "pathType": { "base": null, "refs": { "CreateGroupRequest$Path": "The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
", "CreateInstanceProfileRequest$Path": "The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
", "CreateRoleRequest$Path": "The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
", "CreateUserRequest$Path": "The path for the user name. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
", "CreateVirtualMFADeviceRequest$Path": "The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
", "Group$Path": "The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "GroupDetail$Path": "The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "InstanceProfile$Path": "The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "ListEntitiesForPolicyRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
", "Role$Path": "The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "RoleDetail$Path": "The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "ServerCertificateMetadata$Path": "The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "UpdateGroupRequest$NewPath": "New path for the group. Only include this if changing the group's path.
", "UpdateServerCertificateRequest$NewPath": "The new path for the server certificate. Include this only if you are updating the server certificate's path.
", "UpdateUserRequest$NewPath": "New path for the user. Include this parameter only if you're changing the user's path.
", "UploadServerCertificateRequest$Path": "The path for the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
--path option. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/). The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
", "UserDetail$Path": "The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
" } }, "policyDescriptionType": { "base": null, "refs": { "CreatePolicyRequest$Description": "A friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"
The policy description is immutable. After a value is assigned, it cannot be changed.
", "ManagedPolicyDetail$Description": "A friendly description of the policy.
", "Policy$Description": "A friendly description of the policy.
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
" } }, "policyDetailListType": { "base": null, "refs": { "GroupDetail$GroupPolicyList": "A list of the inline policies embedded in the group.
", "RoleDetail$RolePolicyList": "A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.
", "UserDetail$UserPolicyList": "A list of the inline policies embedded in the user.
" } }, "policyDocumentType": { "base": null, "refs": { "CreatePolicyRequest$PolicyDocument": "The policy document.
The policy must be URL-encoded according to RFC 3986.
", "CreatePolicyVersionRequest$PolicyDocument": "The policy document.
The policy must be URL-encoded according to RFC 3986.
", "CreateRoleRequest$AssumeRolePolicyDocument": "The policy that grants an entity permission to assume the role.
", "GetGroupPolicyResponse$PolicyDocument": "The policy document.
", "GetRolePolicyResponse$PolicyDocument": "The policy document.
", "GetUserPolicyResponse$PolicyDocument": "The policy document.
", "PolicyDetail$PolicyDocument": "The policy document.
The returned policy is URL-encoded according to RFC 3986.
", "PolicyVersion$Document": "The policy document.
The policy document is returned in the response to the GetPolicyVersion operation. It is not included in the response to the ListPolicyVersions or GetAccountAuthorizationDetails operations.
", "PutGroupPolicyRequest$PolicyDocument": "The policy document.
", "PutRolePolicyRequest$PolicyDocument": "The policy document.
", "PutUserPolicyRequest$PolicyDocument": "The policy document.
", "Role$AssumeRolePolicyDocument": "The policy that grants an entity permission to assume the role.
The returned policy is URL-encoded according to RFC 3986.
", "RoleDetail$AssumeRolePolicyDocument": "The trust policy that grants permission to assume the role.
The returned policy is URL-encoded according to RFC 3986.
", "UpdateAssumeRolePolicyRequest$PolicyDocument": "The policy that grants an entity permission to assume the role.
" } }, "policyDocumentVersionListType": { "base": null, "refs": { "ListPolicyVersionsResponse$Versions": "A list of policy versions.
For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.
", "ManagedPolicyDetail$PolicyVersionList": "A list containing information about the versions of the policy.
" } }, "policyListType": { "base": null, "refs": { "ListPoliciesResponse$Policies": "A list of policies.
" } }, "policyNameListType": { "base": "Contains a list of policy names.
This data type is used as a response element in the ListPolicies action.
", "refs": { "ListGroupPoliciesResponse$PolicyNames": "A list of policy names.
", "ListRolePoliciesResponse$PolicyNames": "A list of policy names.
", "ListUserPoliciesResponse$PolicyNames": "A list of policy names.
" } }, "policyNameType": { "base": null, "refs": { "AttachedPolicy$PolicyName": "The friendly name of the attached policy.
", "CreatePolicyRequest$PolicyName": "The name of the policy document.
", "DeleteGroupPolicyRequest$PolicyName": "The name identifying the policy document to delete.
", "DeleteRolePolicyRequest$PolicyName": "The name identifying the policy document to delete.
", "DeleteUserPolicyRequest$PolicyName": "The name identifying the policy document to delete.
", "GetGroupPolicyRequest$PolicyName": "The name of the policy document to get.
", "GetGroupPolicyResponse$PolicyName": "The name of the policy.
", "GetRolePolicyRequest$PolicyName": "The name of the policy document to get.
", "GetRolePolicyResponse$PolicyName": "The name of the policy.
", "GetUserPolicyRequest$PolicyName": "The name of the policy document to get.
", "GetUserPolicyResponse$PolicyName": "The name of the policy.
", "ManagedPolicyDetail$PolicyName": "The friendly name (not ARN) identifying the policy.
", "Policy$PolicyName": "The friendly name (not ARN) identifying the policy.
", "PolicyDetail$PolicyName": "The name of the policy.
", "PutGroupPolicyRequest$PolicyName": "The name of the policy document.
", "PutRolePolicyRequest$PolicyName": "The name of the policy document.
", "PutUserPolicyRequest$PolicyName": "The name of the policy document.
", "policyNameListType$member": null } }, "policyPathType": { "base": null, "refs": { "CreatePolicyRequest$Path": "The path for the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
", "ListAttachedGroupPoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
", "ListAttachedRolePoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
", "ListAttachedUserPoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
", "ListPoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
", "ManagedPolicyDetail$Path": "The path to the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
", "Policy$Path": "The path to the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
" } }, "policyScopeType": { "base": null, "refs": { "ListPoliciesRequest$Scope": "The scope to use for filtering the results.
To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local.
This parameter is optional. If it is not included, or if it is set to All, all policies are returned.
The policy version to delete.
For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.
", "GetPolicyVersionRequest$VersionId": "Identifies the policy version to retrieve.
", "ManagedPolicyDetail$DefaultVersionId": "The identifier for the version of the policy that is set as the default (operative) version.
For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.
", "Policy$DefaultVersionId": "The identifier for the version of the policy that is set as the default version.
", "PolicyVersion$VersionId": "The identifier for the policy version.
Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.
The version of the policy to set as the default (operative) version.
For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.
" } }, "privateKeyType": { "base": null, "refs": { "UploadServerCertificateRequest$PrivateKey": "The contents of the private key in PEM-encoded format.
" } }, "roleDetailListType": { "base": null, "refs": { "GetAccountAuthorizationDetailsResponse$RoleDetailList": "A list containing information about IAM roles.
" } }, "roleListType": { "base": "Contains a list of IAM roles.
This data type is used as a response element in the ListRoles action.
", "refs": { "InstanceProfile$Roles": "The role associated with the instance profile.
", "ListRolesResponse$Roles": "A list of roles.
" } }, "roleNameType": { "base": null, "refs": { "AddRoleToInstanceProfileRequest$RoleName": "The name of the role to add.
", "AttachRolePolicyRequest$RoleName": "The name (friendly name, not ARN) of the role to attach the policy to.
", "CreateRoleRequest$RoleName": "The name of the role to create.
", "DeleteRolePolicyRequest$RoleName": "The name (friendly name, not ARN) identifying the role that the policy is embedded in.
", "DeleteRoleRequest$RoleName": "The name of the role to delete.
", "DetachRolePolicyRequest$RoleName": "The name (friendly name, not ARN) of the role to detach the policy from.
", "GetRolePolicyRequest$RoleName": "The name of the role associated with the policy.
", "GetRolePolicyResponse$RoleName": "The role the policy is associated with.
", "GetRoleRequest$RoleName": "The name of the role to get information about.
", "ListAttachedRolePoliciesRequest$RoleName": "The name (friendly name, not ARN) of the role to list attached policies for.
", "ListInstanceProfilesForRoleRequest$RoleName": "The name of the role to list instance profiles for.
", "ListRolePoliciesRequest$RoleName": "The name of the role to list policies for.
", "PolicyRole$RoleName": "The name (friendly name, not ARN) identifying the role.
", "PutRolePolicyRequest$RoleName": "The name of the role to associate the policy with.
", "RemoveRoleFromInstanceProfileRequest$RoleName": "The name of the role to remove.
", "Role$RoleName": "The friendly name that identifies the role.
", "RoleDetail$RoleName": "The friendly name that identifies the role.
", "UpdateAssumeRolePolicyRequest$RoleName": "The name of the role to update.
" } }, "serialNumberType": { "base": null, "refs": { "DeactivateMFADeviceRequest$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
", "DeleteVirtualMFADeviceRequest$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.
", "EnableMFADeviceRequest$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
", "MFADevice$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
", "ResyncMFADeviceRequest$SerialNumber": "Serial number that uniquely identifies the MFA device.
", "VirtualMFADevice$SerialNumber": "The serial number associated with VirtualMFADevice.
A list of server certificates.
" } }, "serverCertificateNameType": { "base": null, "refs": { "DeleteServerCertificateRequest$ServerCertificateName": "The name of the server certificate you want to delete.
", "GetServerCertificateRequest$ServerCertificateName": "The name of the server certificate you want to retrieve information about.
", "ServerCertificateMetadata$ServerCertificateName": "The name that identifies the server certificate.
", "UpdateServerCertificateRequest$ServerCertificateName": "The name of the server certificate that you want to update.
", "UpdateServerCertificateRequest$NewServerCertificateName": "The new name for the server certificate. Include this only if you are updating the server certificate's name.
", "UploadServerCertificateRequest$ServerCertificateName": "The name for the server certificate. Do not include the path in this value.
" } }, "serviceFailureExceptionMessage": { "base": null, "refs": { "ServiceFailureException$message": null } }, "statusType": { "base": null, "refs": { "AccessKey$Status": " The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
The status of the access key. Active means the key is valid for API calls; Inactive means it is not.
The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.
The status you want to assign to the secret access key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.
The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.
A set of key value pairs containing information about IAM entity usage and IAM quotas.
SummaryMap contains the following keys:
AccessKeysPerUserQuota
The maximum number of active access keys allowed for each IAM user.
AccountAccessKeysPresent
This value is 1 if the AWS account (root) has an access key, otherwise it is 0.
AccountMFAEnabled
This value is 1 if the AWS account (root) has an MFA device assigned, otherwise it is 0.
AccountSigningCertificatesPresent
This value is 1 if the AWS account (root) has a signing certificate, otherwise it is 0.
AssumeRolePolicySizeQuota
The maximum allowed size for assume role policy documents (trust policies), in non-whitespace characters.
AttachedPoliciesPerGroupQuota
The maximum number of managed policies that can be attached to an IAM group.
AttachedPoliciesPerRoleQuota
The maximum number of managed policies that can be attached to an IAM role.
AttachedPoliciesPerUserQuota
The maximum number of managed policies that can be attached to an IAM user.
GroupPolicySizeQuota
The maximum allowed size for the aggregate of all inline policies embedded in an IAM group, in non-whitespace characters.
Groups
The number of IAM groups in the AWS account.
GroupsPerUserQuota
The maximum number of IAM groups each IAM user can belong to.
GroupsQuota
The maximum number of IAM groups allowed in the AWS account.
InstanceProfiles
The number of instance profiles in the AWS account.
InstanceProfilesQuota
The maximum number of instance profiles allowed in the AWS account.
MFADevices
The number of MFA devices in the AWS account, including those assigned and unassigned.
MFADevicesInUse
The number of MFA devices that have been assigned to an IAM user or to the AWS account (root).
Policies
The number of customer managed policies in the AWS account.
PoliciesQuota
The maximum number of customer managed policies allowed in the AWS account.
PolicySizeQuota
The maximum allowed size of a customer managed policy, in non-whitespace characters.
PolicyVersionsInUse
The number of managed policies that are attached to IAM users, groups, or roles in the AWS account.
PolicyVersionsInUseQuota
The maximum number of managed policies that can be attached to IAM users, groups, or roles in the AWS account.
Providers
The number of identity providers in the AWS account.
RolePolicySizeQuota
The maximum allowed size for the aggregate of all inline policies (access policies, not the trust policy) embedded in an IAM role, in non-whitespace characters.
Roles
The number of IAM roles in the AWS account.
RolesQuota
The maximum number of IAM roles allowed in the AWS account.
ServerCertificates
The number of server certificates in the AWS account.
ServerCertificatesQuota
The maximum number of server certificates allowed in the AWS account.
SigningCertificatesPerUserQuota
The maximum number of X.509 signing certificates allowed for each IAM user.
UserPolicySizeQuota
The maximum allowed size for the aggregate of all inline policies embedded in an IAM user, in non-whitespace characters.
Users
The number of IAM users in the AWS account.
UsersQuota
The maximum number of IAM users allowed in the AWS account.
VersionsPerPolicyQuota
The maximum number of policy versions allowed for each managed policy.
Contains a list of thumbprints of identity provider server certificates.
", "refs": { "CreateOpenIDConnectProviderRequest$ThumbprintList": "A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is server.example.com and the provider stores its keys at \"https://keys.server.example.com/openid-connect\", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.
For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the Using IAM guide.
", "GetOpenIDConnectProviderResponse$ThumbprintList": "A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
", "UpdateOpenIDConnectProviderThumbprintRequest$ThumbprintList": "A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
" } }, "thumbprintType": { "base": "Contains a thumbprint for an identity provider's server certificate.
The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
", "refs": { "thumbprintListType$member": null } }, "userDetailListType": { "base": null, "refs": { "GetAccountAuthorizationDetailsResponse$UserDetailList": "A list containing information about IAM users.
" } }, "userListType": { "base": "Contains a list of users.
This data type is used as a response element in the GetGroup and ListUsers actions.
", "refs": { "GetGroupResponse$Users": "A list of users in the group.
", "ListUsersResponse$Users": "A list of users.
" } }, "userNameType": { "base": null, "refs": { "AccessKey$UserName": "The name of the IAM user that the access key is associated with.
", "AccessKeyMetadata$UserName": "The name of the IAM user that the key is associated with.
", "AttachUserPolicyRequest$UserName": "The name (friendly name, not ARN) of the user to attach the policy to.
", "CreateLoginProfileRequest$UserName": "The name of the user to create a password for.
", "CreateUserRequest$UserName": "The name of the user to create.
", "DeleteLoginProfileRequest$UserName": "The name of the user whose password you want to delete.
", "DetachUserPolicyRequest$UserName": "The name (friendly name, not ARN) of the user to detach the policy from.
", "GetLoginProfileRequest$UserName": "The name of the user whose login profile you want to retrieve.
", "ListAttachedUserPoliciesRequest$UserName": "The name (friendly name, not ARN) of the user to list attached policies for.
", "LoginProfile$UserName": "The name of the user, which can be used for signing in to the AWS Management Console.
", "MFADevice$UserName": "The user with whom the MFA device is associated.
", "PolicyUser$UserName": "The name (friendly name, not ARN) identifying the user.
", "SigningCertificate$UserName": "The name of the user the signing certificate is associated with.
", "UpdateLoginProfileRequest$UserName": "The name of the user whose password you want to update.
", "UpdateUserRequest$NewUserName": "New name for the user. Include this parameter only if you're changing the user's name.
", "User$UserName": "The friendly name identifying the user.
", "UserDetail$UserName": "The friendly name identifying the user.
" } }, "virtualMFADeviceListType": { "base": null, "refs": { "ListVirtualMFADevicesResponse$VirtualMFADevices": " The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.
The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
" } } } }