libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.Lens

Contents

Description

 
Synopsis

Operations

GetContextKeysForPrincipalPolicy

getContextKeysForPrincipalPolicy_policyInputList :: Lens' GetContextKeysForPrincipalPolicy (Maybe [Text]) Source #

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

getContextKeysForPrincipalPolicy_policySourceArn :: Lens' GetContextKeysForPrincipalPolicy Text Source #

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

getContextKeysForPolicyResponse_contextKeyNames :: Lens' GetContextKeysForPolicyResponse (Maybe [Text]) Source #

The list of context keys that are referenced in the input policies.

ListPolicies

listPolicies_pathPrefix :: Lens' ListPolicies (Maybe Text) Source #

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listPolicies_onlyAttached :: Lens' ListPolicies (Maybe Bool) Source #

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 an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

listPolicies_marker :: Lens' ListPolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listPolicies_scope :: Lens' ListPolicies (Maybe PolicyScopeType) Source #

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services 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.

listPolicies_maxItems :: Lens' ListPolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listPolicies_policyUsageFilter :: Lens' ListPolicies (Maybe PolicyUsageType) Source #

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

listPoliciesResponse_marker :: Lens' ListPoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listPoliciesResponse_isTruncated :: Lens' ListPoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

CreatePolicy

createPolicy_path :: Lens' CreatePolicy (Maybe Text) Source #

The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

createPolicy_description :: Lens' CreatePolicy (Maybe Text) Source #

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.

createPolicy_tags :: Lens' CreatePolicy (Maybe [Tag]) Source #

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createPolicy_policyName :: Lens' CreatePolicy Text Source #

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

createPolicy_policyDocument :: Lens' CreatePolicy Text Source #

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

createPolicyResponse_policy :: Lens' CreatePolicyResponse (Maybe Policy) Source #

A structure containing details about the new policy.

ListInstanceProfilesForRole

listInstanceProfilesForRole_marker :: Lens' ListInstanceProfilesForRole (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listInstanceProfilesForRole_maxItems :: Lens' ListInstanceProfilesForRole (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listInstanceProfilesForRole_roleName :: Lens' ListInstanceProfilesForRole Text Source #

The name of the role to list instance profiles for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listInstanceProfilesForRoleResponse_marker :: Lens' ListInstanceProfilesForRoleResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listInstanceProfilesForRoleResponse_isTruncated :: Lens' ListInstanceProfilesForRoleResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

AttachGroupPolicy

attachGroupPolicy_groupName :: Lens' AttachGroupPolicy Text Source #

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

attachGroupPolicy_policyArn :: Lens' AttachGroupPolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreateAccessKey

createAccessKey_userName :: Lens' CreateAccessKey (Maybe Text) Source #

The name of the IAM user that the new key will belong to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

createAccessKeyResponse_accessKey :: Lens' CreateAccessKeyResponse AccessKeyInfo Source #

A structure with details about the access key.

ListRoleTags

listRoleTags_marker :: Lens' ListRoleTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listRoleTags_maxItems :: Lens' ListRoleTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listRoleTags_roleName :: Lens' ListRoleTags Text Source #

The name of the IAM role for which you want to see the list of tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listRoleTagsResponse_marker :: Lens' ListRoleTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listRoleTagsResponse_isTruncated :: Lens' ListRoleTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listRoleTagsResponse_tags :: Lens' ListRoleTagsResponse [Tag] Source #

The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

ListSSHPublicKeys

listSSHPublicKeys_userName :: Lens' ListSSHPublicKeys (Maybe Text) Source #

The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listSSHPublicKeys_marker :: Lens' ListSSHPublicKeys (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listSSHPublicKeys_maxItems :: Lens' ListSSHPublicKeys (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listSSHPublicKeysResponse_marker :: Lens' ListSSHPublicKeysResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listSSHPublicKeysResponse_isTruncated :: Lens' ListSSHPublicKeysResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

UntagOpenIDConnectProvider

untagOpenIDConnectProvider_openIDConnectProviderArn :: Lens' UntagOpenIDConnectProvider Text Source #

The ARN of the OIDC provider in IAM from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagOpenIDConnectProvider_tagKeys :: Lens' UntagOpenIDConnectProvider [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified OIDC provider.

ListOpenIDConnectProviders

listOpenIDConnectProvidersResponse_openIDConnectProviderList :: Lens' ListOpenIDConnectProvidersResponse (Maybe [OpenIDConnectProviderListEntry]) Source #

The list of IAM OIDC provider resource objects defined in the Amazon Web Services account.

CreateVirtualMFADevice

createVirtualMFADevice_path :: Lens' CreateVirtualMFADevice (Maybe Text) Source #

The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

createVirtualMFADevice_tags :: Lens' CreateVirtualMFADevice (Maybe [Tag]) Source #

A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createVirtualMFADevice_virtualMFADeviceName :: Lens' CreateVirtualMFADevice Text Source #

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

createVirtualMFADeviceResponse_virtualMFADevice :: Lens' CreateVirtualMFADeviceResponse VirtualMFADevice Source #

A structure containing details about the new virtual MFA device.

DeleteAccountPasswordPolicy

UpdateAccountPasswordPolicy

updateAccountPasswordPolicy_minimumPasswordLength :: Lens' UpdateAccountPasswordPolicy (Maybe Natural) Source #

The minimum number of characters allowed in an IAM user password.

If you do not specify a value for this parameter, then the operation uses the default value of 6.

updateAccountPasswordPolicy_requireNumbers :: Lens' UpdateAccountPasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.

updateAccountPasswordPolicy_passwordReusePrevention :: Lens' UpdateAccountPasswordPolicy (Maybe Natural) Source #

Specifies the number of previous passwords that IAM users are prevented from reusing.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.

updateAccountPasswordPolicy_requireLowercaseCharacters :: Lens' UpdateAccountPasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.

updateAccountPasswordPolicy_maxPasswordAge :: Lens' UpdateAccountPasswordPolicy (Maybe Natural) Source #

The number of days that an IAM user password is valid.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.

updateAccountPasswordPolicy_hardExpiry :: Lens' UpdateAccountPasswordPolicy (Maybe Bool) Source #

Prevents IAM users from setting a new password after their password has expired. The IAM user cannot be accessed until an administrator resets the password.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.

updateAccountPasswordPolicy_requireSymbols :: Lens' UpdateAccountPasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.

updateAccountPasswordPolicy_requireUppercaseCharacters :: Lens' UpdateAccountPasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.

updateAccountPasswordPolicy_allowUsersToChangePassword :: Lens' UpdateAccountPasswordPolicy (Maybe Bool) Source #

Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Letting IAM users change their own passwords in the IAM User Guide.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.

AttachRolePolicy

attachRolePolicy_roleName :: Lens' AttachRolePolicy Text Source #

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

attachRolePolicy_policyArn :: Lens' AttachRolePolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

UpdateSSHPublicKey

updateSSHPublicKey_userName :: Lens' UpdateSSHPublicKey Text Source #

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateSSHPublicKey_sSHPublicKeyId :: Lens' UpdateSSHPublicKey Text Source #

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

updateSSHPublicKey_status :: Lens' UpdateSSHPublicKey StatusType Source #

The status to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

DeleteSSHPublicKey

deleteSSHPublicKey_userName :: Lens' DeleteSSHPublicKey Text Source #

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteSSHPublicKey_sSHPublicKeyId :: Lens' DeleteSSHPublicKey Text Source #

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

GetUserPolicy

getUserPolicy_userName :: Lens' GetUserPolicy Text Source #

The name of the user who the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getUserPolicy_policyName :: Lens' GetUserPolicy Text Source #

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getUserPolicyResponse_userName :: Lens' GetUserPolicyResponse Text Source #

The user the policy is associated with.

getUserPolicyResponse_policyDocument :: Lens' GetUserPolicyResponse Text Source #

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

UpdateServiceSpecificCredential

updateServiceSpecificCredential_userName :: Lens' UpdateServiceSpecificCredential (Maybe Text) Source #

The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateServiceSpecificCredential_serviceSpecificCredentialId :: Lens' UpdateServiceSpecificCredential Text Source #

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

updateServiceSpecificCredential_status :: Lens' UpdateServiceSpecificCredential StatusType Source #

The status to be assigned to the service-specific credential.

DeleteServiceSpecificCredential

deleteServiceSpecificCredential_userName :: Lens' DeleteServiceSpecificCredential (Maybe Text) Source #

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteServiceSpecificCredential_serviceSpecificCredentialId :: Lens' DeleteServiceSpecificCredential Text Source #

The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

ListAttachedRolePolicies

listAttachedRolePolicies_pathPrefix :: Lens' ListAttachedRolePolicies (Maybe Text) Source #

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listAttachedRolePolicies_marker :: Lens' ListAttachedRolePolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listAttachedRolePolicies_maxItems :: Lens' ListAttachedRolePolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listAttachedRolePolicies_roleName :: Lens' ListAttachedRolePolicies Text Source #

The name (friendly name, not ARN) of the role to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listAttachedRolePoliciesResponse_marker :: Lens' ListAttachedRolePoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listAttachedRolePoliciesResponse_isTruncated :: Lens' ListAttachedRolePoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

GetRole

getRole_roleName :: Lens' GetRole Text Source #

The name of the IAM role to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getRoleResponse_httpStatus :: Lens' GetRoleResponse Int Source #

The response's http status code.

getRoleResponse_role :: Lens' GetRoleResponse Role Source #

A structure containing details about the IAM role.

DeactivateMFADevice

deactivateMFADevice_userName :: Lens' DeactivateMFADevice Text Source #

The name of the user whose MFA device you want to deactivate.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deactivateMFADevice_serialNumber :: Lens' DeactivateMFADevice Text Source #

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

CreateOpenIDConnectProvider

createOpenIDConnectProvider_clientIDList :: Lens' CreateOpenIDConnectProvider (Maybe [Text]) Source #

Provides 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 operation accepts client IDs up to 255 characters long.

createOpenIDConnectProvider_tags :: Lens' CreateOpenIDConnectProvider (Maybe [Tag]) Source #

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createOpenIDConnectProvider_url :: Lens' CreateOpenIDConnectProvider Text Source #

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 hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.

You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.

createOpenIDConnectProvider_thumbprintList :: Lens' CreateOpenIDConnectProvider [Text] Source #

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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 thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM User Guide.

createOpenIDConnectProviderResponse_openIDConnectProviderArn :: Lens' CreateOpenIDConnectProviderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

createOpenIDConnectProviderResponse_tags :: Lens' CreateOpenIDConnectProviderResponse (Maybe [Tag]) Source #

A list of tags that are attached to the new IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

DeleteVirtualMFADevice

deleteVirtualMFADevice_serialNumber :: Lens' DeleteVirtualMFADevice Text Source #

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

ListRoles

listRoles_pathPrefix :: Lens' ListRoles (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listRoles_marker :: Lens' ListRoles (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listRoles_maxItems :: Lens' ListRoles (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listRolesResponse_marker :: Lens' ListRolesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listRolesResponse_isTruncated :: Lens' ListRolesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listRolesResponse_httpStatus :: Lens' ListRolesResponse Int Source #

The response's http status code.

ListUserPolicies

listUserPolicies_marker :: Lens' ListUserPolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listUserPolicies_maxItems :: Lens' ListUserPolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listUserPolicies_userName :: Lens' ListUserPolicies Text Source #

The name of the user to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listUserPoliciesResponse_marker :: Lens' ListUserPoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listUserPoliciesResponse_isTruncated :: Lens' ListUserPoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

ListOpenIDConnectProviderTags

listOpenIDConnectProviderTags_marker :: Lens' ListOpenIDConnectProviderTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listOpenIDConnectProviderTags_maxItems :: Lens' ListOpenIDConnectProviderTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listOpenIDConnectProviderTags_openIDConnectProviderArn :: Lens' ListOpenIDConnectProviderTags Text Source #

The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listOpenIDConnectProviderTagsResponse_marker :: Lens' ListOpenIDConnectProviderTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listOpenIDConnectProviderTagsResponse_isTruncated :: Lens' ListOpenIDConnectProviderTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listOpenIDConnectProviderTagsResponse_tags :: Lens' ListOpenIDConnectProviderTagsResponse [Tag] Source #

The list of tags that are currently attached to the OpenID Connect (OIDC) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

PutRolePermissionsBoundary

putRolePermissionsBoundary_roleName :: Lens' PutRolePermissionsBoundary Text Source #

The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.

putRolePermissionsBoundary_permissionsBoundary :: Lens' PutRolePermissionsBoundary Text Source #

The ARN of the policy that is used to set the permissions boundary for the role.

UploadSSHPublicKey

uploadSSHPublicKey_userName :: Lens' UploadSSHPublicKey Text Source #

The name of the IAM user to associate the SSH public key with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

uploadSSHPublicKey_sSHPublicKeyBody :: Lens' UploadSSHPublicKey Text Source #

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

DeleteRolePermissionsBoundary

deleteRolePermissionsBoundary_roleName :: Lens' DeleteRolePermissionsBoundary Text Source #

The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.

SimulateCustomPolicy

simulateCustomPolicy_resourcePolicy :: Lens' SimulateCustomPolicy (Maybe Text) Source #

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

simulateCustomPolicy_callerArn :: Lens' SimulateCustomPolicy (Maybe Text) Source #

The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

simulateCustomPolicy_resourceHandlingOption :: Lens' SimulateCustomPolicy (Maybe Text) Source #

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

  • EC2-Classic-InstanceStore

    instance, image, security-group

  • EC2-Classic-EBS

    instance, image, security-group, volume

  • EC2-VPC-InstanceStore

    instance, image, security-group, network-interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security-group, network-interface, subnet

  • EC2-VPC-EBS

    instance, image, security-group, network-interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security-group, network-interface, subnet, volume

simulateCustomPolicy_resourceArns :: Lens' SimulateCustomPolicy (Maybe [Text]) Source #

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

simulateCustomPolicy_permissionsBoundaryPolicyInputList :: Lens' SimulateCustomPolicy (Maybe [Text]) Source #

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

simulateCustomPolicy_marker :: Lens' SimulateCustomPolicy (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

simulateCustomPolicy_maxItems :: Lens' SimulateCustomPolicy (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

simulateCustomPolicy_contextEntries :: Lens' SimulateCustomPolicy (Maybe [ContextEntry]) Source #

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

simulateCustomPolicy_resourceOwner :: Lens' SimulateCustomPolicy (Maybe Text) Source #

An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

simulateCustomPolicy_policyInputList :: Lens' SimulateCustomPolicy [Text] Source #

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

simulateCustomPolicy_actionNames :: Lens' SimulateCustomPolicy [Text] Source #

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

simulatePolicyResponse_marker :: Lens' SimulatePolicyResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

simulatePolicyResponse_isTruncated :: Lens' SimulatePolicyResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

UpdateRole

updateRole_maxSessionDuration :: Lens' UpdateRole (Maybe Natural) Source #

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

updateRole_description :: Lens' UpdateRole (Maybe Text) Source #

The new description that you want to apply to the specified role.

updateRole_roleName :: Lens' UpdateRole Text Source #

The name of the role that you want to modify.

DeleteRole

deleteRole_roleName :: Lens' DeleteRole Text Source #

The name of the role to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

ListUsers

listUsers_pathPrefix :: Lens' ListUsers (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listUsers_marker :: Lens' ListUsers (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listUsers_maxItems :: Lens' ListUsers (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listUsersResponse_marker :: Lens' ListUsersResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listUsersResponse_isTruncated :: Lens' ListUsersResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

UpdateOpenIDConnectProviderThumbprint

updateOpenIDConnectProviderThumbprint_openIDConnectProviderArn :: Lens' UpdateOpenIDConnectProviderThumbprint Text Source #

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

updateOpenIDConnectProviderThumbprint_thumbprintList :: Lens' UpdateOpenIDConnectProviderThumbprint [Text] Source #

A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.

PutUserPolicy

putUserPolicy_userName :: Lens' PutUserPolicy Text Source #

The name of the user to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

putUserPolicy_policyName :: Lens' PutUserPolicy Text Source #

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

putUserPolicy_policyDocument :: Lens' PutUserPolicy Text Source #

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

TagMFADevice

tagMFADevice_serialNumber :: Lens' TagMFADevice Text Source #

The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagMFADevice_tags :: Lens' TagMFADevice [Tag] Source #

The list of tags that you want to attach to the IAM virtual MFA device. Each tag consists of a key name and an associated value.

GetSSHPublicKey

getSSHPublicKey_userName :: Lens' GetSSHPublicKey Text Source #

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getSSHPublicKey_sSHPublicKeyId :: Lens' GetSSHPublicKey Text Source #

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

getSSHPublicKey_encoding :: Lens' GetSSHPublicKey EncodingType Source #

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

getSSHPublicKeyResponse_sSHPublicKey :: Lens' GetSSHPublicKeyResponse (Maybe SSHPublicKey) Source #

A structure containing details about the SSH public key.

UntagUser

untagUser_userName :: Lens' UntagUser Text Source #

The name of the IAM user from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagUser_tagKeys :: Lens' UntagUser [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user.

DetachGroupPolicy

detachGroupPolicy_groupName :: Lens' DetachGroupPolicy Text Source #

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

detachGroupPolicy_policyArn :: Lens' DetachGroupPolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

TagInstanceProfile

tagInstanceProfile_instanceProfileName :: Lens' TagInstanceProfile Text Source #

The name of the IAM instance profile to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagInstanceProfile_tags :: Lens' TagInstanceProfile [Tag] Source #

The list of tags that you want to attach to the IAM instance profile. Each tag consists of a key name and an associated value.

GetOpenIDConnectProvider

getOpenIDConnectProvider_openIDConnectProviderArn :: Lens' GetOpenIDConnectProvider Text Source #

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

getOpenIDConnectProviderResponse_createDate :: Lens' GetOpenIDConnectProviderResponse (Maybe UTCTime) Source #

The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account.

getOpenIDConnectProviderResponse_url :: Lens' GetOpenIDConnectProviderResponse (Maybe Text) Source #

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

getOpenIDConnectProviderResponse_thumbprintList :: Lens' GetOpenIDConnectProviderResponse (Maybe [Text]) Source #

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

getOpenIDConnectProviderResponse_clientIDList :: Lens' GetOpenIDConnectProviderResponse (Maybe [Text]) Source #

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

getOpenIDConnectProviderResponse_tags :: Lens' GetOpenIDConnectProviderResponse (Maybe [Tag]) Source #

A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

PutUserPermissionsBoundary

putUserPermissionsBoundary_userName :: Lens' PutUserPermissionsBoundary Text Source #

The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

putUserPermissionsBoundary_permissionsBoundary :: Lens' PutUserPermissionsBoundary Text Source #

The ARN of the policy that is used to set the permissions boundary for the user.

DeleteUserPolicy

deleteUserPolicy_userName :: Lens' DeleteUserPolicy Text Source #

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteUserPolicy_policyName :: Lens' DeleteUserPolicy Text Source #

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

TagSAMLProvider

tagSAMLProvider_sAMLProviderArn :: Lens' TagSAMLProvider Text Source #

The ARN of the SAML identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagSAMLProvider_tags :: Lens' TagSAMLProvider [Tag] Source #

The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value.

DeleteUserPermissionsBoundary

deleteUserPermissionsBoundary_userName :: Lens' DeleteUserPermissionsBoundary Text Source #

The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.

CreateRole

createRole_maxSessionDuration :: Lens' CreateRole (Maybe Natural) Source #

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

createRole_path :: Lens' CreateRole (Maybe Text) Source #

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

createRole_permissionsBoundary :: Lens' CreateRole (Maybe Text) Source #

The ARN of the policy that is used to set the permissions boundary for the role.

createRole_description :: Lens' CreateRole (Maybe Text) Source #

A description of the role.

createRole_tags :: Lens' CreateRole (Maybe [Tag]) Source #

A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createRole_roleName :: Lens' CreateRole Text Source #

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

createRole_assumeRolePolicyDocument :: Lens' CreateRole Text Source #

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Upon success, the response includes the same trust policy in JSON format.

createRoleResponse_role :: Lens' CreateRoleResponse Role Source #

A structure containing details about the new role.

ResetServiceSpecificCredential

resetServiceSpecificCredential_userName :: Lens' ResetServiceSpecificCredential (Maybe Text) Source #

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

resetServiceSpecificCredential_serviceSpecificCredentialId :: Lens' ResetServiceSpecificCredential Text Source #

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

resetServiceSpecificCredentialResponse_serviceSpecificCredential :: Lens' ResetServiceSpecificCredentialResponse (Maybe ServiceSpecificCredential) Source #

A structure with details about the updated service-specific credential, including the new password.

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.

UntagSAMLProvider

untagSAMLProvider_sAMLProviderArn :: Lens' UntagSAMLProvider Text Source #

The ARN of the SAML identity provider in IAM from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagSAMLProvider_tagKeys :: Lens' UntagSAMLProvider [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified SAML identity provider.

GetCredentialReport

getCredentialReportResponse_content :: Lens' GetCredentialReportResponse (Maybe ByteString) Source #

Contains the credential report. The report is Base64-encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

ListServerCertificateTags

listServerCertificateTags_marker :: Lens' ListServerCertificateTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listServerCertificateTags_maxItems :: Lens' ListServerCertificateTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listServerCertificateTags_serverCertificateName :: Lens' ListServerCertificateTags Text Source #

The name of the IAM server certificate whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listServerCertificateTagsResponse_marker :: Lens' ListServerCertificateTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listServerCertificateTagsResponse_isTruncated :: Lens' ListServerCertificateTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listServerCertificateTagsResponse_tags :: Lens' ListServerCertificateTagsResponse [Tag] Source #

The list of tags that are currently attached to the IAM server certificate. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

GetAccountSummary

getAccountSummaryResponse_summaryMap :: Lens' GetAccountSummaryResponse (Maybe (HashMap SummaryKeyType Int)) Source #

A set of key–value pairs containing information about IAM entity usage and IAM quotas.

GenerateServiceLastAccessedDetails

generateServiceLastAccessedDetails_granularity :: Lens' GenerateServiceLastAccessedDetails (Maybe AccessAdvisorUsageGranularityType) Source #

The level of detail that you want to generate. You can specify whether you want to generate information about the last attempt to access services or actions. If you specify service-level granularity, this operation generates only service data. If you specify action-level granularity, it generates service and action data. If you don't include this optional parameter, the operation generates service data.

generateServiceLastAccessedDetails_arn :: Lens' GenerateServiceLastAccessedDetails Text Source #

The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an Amazon Web Services service.

generateServiceLastAccessedDetailsResponse_jobId :: Lens' GenerateServiceLastAccessedDetailsResponse (Maybe Text) Source #

The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

ListPolicyTags

listPolicyTags_marker :: Lens' ListPolicyTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listPolicyTags_maxItems :: Lens' ListPolicyTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listPolicyTags_policyArn :: Lens' ListPolicyTags Text Source #

The ARN of the IAM customer managed policy whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listPolicyTagsResponse_marker :: Lens' ListPolicyTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listPolicyTagsResponse_isTruncated :: Lens' ListPolicyTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listPolicyTagsResponse_tags :: Lens' ListPolicyTagsResponse [Tag] Source #

The list of tags that are currently attached to the IAM customer managed policy. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

ListGroupPolicies

listGroupPolicies_marker :: Lens' ListGroupPolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listGroupPolicies_maxItems :: Lens' ListGroupPolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listGroupPolicies_groupName :: Lens' ListGroupPolicies Text Source #

The name of the group to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listGroupPoliciesResponse_marker :: Lens' ListGroupPoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listGroupPoliciesResponse_isTruncated :: Lens' ListGroupPoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listGroupPoliciesResponse_policyNames :: Lens' ListGroupPoliciesResponse [Text] Source #

A list of policy names.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

DeletePolicyVersion

deletePolicyVersion_policyArn :: Lens' DeletePolicyVersion Text Source #

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

deletePolicyVersion_versionId :: Lens' DeletePolicyVersion Text Source #

The policy version to delete.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

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

TagUser

tagUser_userName :: Lens' TagUser Text Source #

The name of the IAM user to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagUser_tags :: Lens' TagUser [Tag] Source #

The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

DeleteInstanceProfile

deleteInstanceProfile_instanceProfileName :: Lens' DeleteInstanceProfile Text Source #

The name of the instance profile to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

DetachRolePolicy

detachRolePolicy_roleName :: Lens' DetachRolePolicy Text Source #

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

detachRolePolicy_policyArn :: Lens' DetachRolePolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

RemoveRoleFromInstanceProfile

removeRoleFromInstanceProfile_instanceProfileName :: Lens' RemoveRoleFromInstanceProfile Text Source #

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

removeRoleFromInstanceProfile_roleName :: Lens' RemoveRoleFromInstanceProfile Text Source #

The name of the role to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

CreatePolicyVersion

createPolicyVersion_setAsDefault :: Lens' CreatePolicyVersion (Maybe Bool) Source #

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, it becomes 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 IAM User Guide.

createPolicyVersion_policyArn :: Lens' CreatePolicyVersion Text Source #

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

createPolicyVersion_policyDocument :: Lens' CreatePolicyVersion Text Source #

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

createPolicyVersionResponse_policyVersion :: Lens' CreatePolicyVersionResponse (Maybe PolicyVersion) Source #

A structure containing details about the new policy version.

CreateInstanceProfile

createInstanceProfile_path :: Lens' CreateInstanceProfile (Maybe Text) Source #

The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

createInstanceProfile_tags :: Lens' CreateInstanceProfile (Maybe [Tag]) Source #

A list of tags that you want to attach to the newly created IAM instance profile. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createInstanceProfile_instanceProfileName :: Lens' CreateInstanceProfile Text Source #

The name of the instance profile to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

createInstanceProfileResponse_instanceProfile :: Lens' CreateInstanceProfileResponse InstanceProfile Source #

A structure containing details about the new instance profile.

CreateSAMLProvider

createSAMLProvider_tags :: Lens' CreateSAMLProvider (Maybe [Tag]) Source #

A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createSAMLProvider_sAMLMetadataDocument :: Lens' CreateSAMLProvider Text Source #

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 About SAML 2.0-based federation in the IAM User Guide

createSAMLProvider_name :: Lens' CreateSAMLProvider Text Source #

The name of the provider to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

createSAMLProviderResponse_sAMLProviderArn :: Lens' CreateSAMLProviderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

createSAMLProviderResponse_tags :: Lens' CreateSAMLProviderResponse (Maybe [Tag]) Source #

A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

GetAccountAuthorizationDetails

getAccountAuthorizationDetails_marker :: Lens' GetAccountAuthorizationDetails (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getAccountAuthorizationDetails_maxItems :: Lens' GetAccountAuthorizationDetails (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getAccountAuthorizationDetails_filter :: Lens' GetAccountAuthorizationDetails (Maybe [EntityType]) Source #

A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

getAccountAuthorizationDetailsResponse_marker :: Lens' GetAccountAuthorizationDetailsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getAccountAuthorizationDetailsResponse_isTruncated :: Lens' GetAccountAuthorizationDetailsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

GetServiceLinkedRoleDeletionStatus

getServiceLinkedRoleDeletionStatus_deletionTaskId :: Lens' GetServiceLinkedRoleDeletionStatus Text Source #

The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

DeleteAccountAlias

deleteAccountAlias_accountAlias :: Lens' DeleteAccountAlias Text Source #

The name of the account alias to delete.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

DetachUserPolicy

detachUserPolicy_userName :: Lens' DetachUserPolicy Text Source #

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

detachUserPolicy_policyArn :: Lens' DetachUserPolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

RemoveUserFromGroup

removeUserFromGroup_groupName :: Lens' RemoveUserFromGroup Text Source #

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

removeUserFromGroup_userName :: Lens' RemoveUserFromGroup Text Source #

The name of the user to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

DeleteGroupPolicy

deleteGroupPolicy_groupName :: Lens' DeleteGroupPolicy Text Source #

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteGroupPolicy_policyName :: Lens' DeleteGroupPolicy Text Source #

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

TagRole

tagRole_roleName :: Lens' TagRole Text Source #

The name of the IAM role to which you want to add tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagRole_tags :: Lens' TagRole [Tag] Source #

The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value.

PutGroupPolicy

putGroupPolicy_groupName :: Lens' PutGroupPolicy Text Source #

The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

putGroupPolicy_policyName :: Lens' PutGroupPolicy Text Source #

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

putGroupPolicy_policyDocument :: Lens' PutGroupPolicy Text Source #

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

GetLoginProfile

getLoginProfile_userName :: Lens' GetLoginProfile Text Source #

The name of the user whose login profile you want to retrieve.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getLoginProfileResponse_loginProfile :: Lens' GetLoginProfileResponse LoginProfile Source #

A structure containing the user name and the profile creation date for the user.

GetGroupPolicy

getGroupPolicy_groupName :: Lens' GetGroupPolicy Text Source #

The name of the group the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getGroupPolicy_policyName :: Lens' GetGroupPolicy Text Source #

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getGroupPolicyResponse_groupName :: Lens' GetGroupPolicyResponse Text Source #

The group the policy is associated with.

getGroupPolicyResponse_policyDocument :: Lens' GetGroupPolicyResponse Text Source #

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

GenerateOrganizationsAccessReport

generateOrganizationsAccessReport_organizationsPolicyId :: Lens' GenerateOrganizationsAccessReport (Maybe Text) Source #

The identifier of the Organizations service control policy (SCP). This parameter is optional.

This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an Amazon Web Services service.

generateOrganizationsAccessReport_entityPath :: Lens' GenerateOrganizationsAccessReport Text Source #

The path of the Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.

generateOrganizationsAccessReportResponse_jobId :: Lens' GenerateOrganizationsAccessReportResponse (Maybe Text) Source #

The job identifier that you can use in the GetOrganizationsAccessReport operation.

ChangePassword

changePassword_oldPassword :: Lens' ChangePassword Text Source #

The IAM user's current password.

changePassword_newPassword :: Lens' ChangePassword Text Source #

The new password. The new password must conform to the Amazon Web Services account's password policy, if one exists.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

ListServerCertificates

listServerCertificates_pathPrefix :: Lens' ListServerCertificates (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listServerCertificates_marker :: Lens' ListServerCertificates (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listServerCertificates_maxItems :: Lens' ListServerCertificates (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listServerCertificatesResponse_marker :: Lens' ListServerCertificatesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listServerCertificatesResponse_isTruncated :: Lens' ListServerCertificatesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

DeleteServiceLinkedRole

deleteServiceLinkedRole_roleName :: Lens' DeleteServiceLinkedRole Text Source #

The name of the service-linked role to be deleted.

deleteServiceLinkedRoleResponse_deletionTaskId :: Lens' DeleteServiceLinkedRoleResponse Text Source #

The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

DeletePolicy

deletePolicy_policyArn :: Lens' DeletePolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

UpdateAssumeRolePolicy

updateAssumeRolePolicy_roleName :: Lens' UpdateAssumeRolePolicy Text Source #

The name of the role to update with the new policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateAssumeRolePolicy_policyDocument :: Lens' UpdateAssumeRolePolicy Text Source #

The policy that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

GetServiceLastAccessedDetailsWithEntities

getServiceLastAccessedDetailsWithEntities_marker :: Lens' GetServiceLastAccessedDetailsWithEntities (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getServiceLastAccessedDetailsWithEntities_maxItems :: Lens' GetServiceLastAccessedDetailsWithEntities (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getServiceLastAccessedDetailsWithEntities_jobId :: Lens' GetServiceLastAccessedDetailsWithEntities Text Source #

The ID of the request generated by the GenerateServiceLastAccessedDetails operation.

getServiceLastAccessedDetailsWithEntities_serviceNamespace :: Lens' GetServiceLastAccessedDetailsWithEntities Text Source #

The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

getServiceLastAccessedDetailsWithEntitiesResponse_marker :: Lens' GetServiceLastAccessedDetailsWithEntitiesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getServiceLastAccessedDetailsWithEntitiesResponse_isTruncated :: Lens' GetServiceLastAccessedDetailsWithEntitiesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

getServiceLastAccessedDetailsWithEntitiesResponse_jobCompletionDate :: Lens' GetServiceLastAccessedDetailsWithEntitiesResponse UTCTime Source #

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

getServiceLastAccessedDetailsWithEntitiesResponse_entityDetailsList :: Lens' GetServiceLastAccessedDetailsWithEntitiesResponse [EntityDetails] Source #

An EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service.

UntagServerCertificate

untagServerCertificate_serverCertificateName :: Lens' UntagServerCertificate Text Source #

The name of the IAM server certificate from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagServerCertificate_tagKeys :: Lens' UntagServerCertificate [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified IAM server certificate.

GetInstanceProfile

getInstanceProfile_instanceProfileName :: Lens' GetInstanceProfile Text Source #

The name of the instance profile to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getInstanceProfileResponse_instanceProfile :: Lens' GetInstanceProfileResponse InstanceProfile Source #

A structure containing details about the instance profile.

CreateLoginProfile

createLoginProfile_passwordResetRequired :: Lens' CreateLoginProfile (Maybe Bool) Source #

Specifies whether the user is required to set a new password on next sign-in.

createLoginProfile_userName :: Lens' CreateLoginProfile Text Source #

The name of the IAM user to create a password for. The user must already exist.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

createLoginProfile_password :: Lens' CreateLoginProfile Text Source #

The new password for the user.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

createLoginProfileResponse_loginProfile :: Lens' CreateLoginProfileResponse LoginProfile Source #

A structure containing the user name and password create date.

GetSAMLProvider

getSAMLProvider_sAMLProviderArn :: Lens' GetSAMLProvider Text Source #

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

getSAMLProviderResponse_createDate :: Lens' GetSAMLProviderResponse (Maybe UTCTime) Source #

The date and time when the SAML provider was created.

getSAMLProviderResponse_validUntil :: Lens' GetSAMLProviderResponse (Maybe UTCTime) Source #

The expiration date and time for the SAML provider.

getSAMLProviderResponse_tags :: Lens' GetSAMLProviderResponse (Maybe [Tag]) Source #

A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

getSAMLProviderResponse_sAMLMetadataDocument :: Lens' GetSAMLProviderResponse (Maybe Text) Source #

The XML metadata document that includes information about an identity provider.

AddRoleToInstanceProfile

addRoleToInstanceProfile_instanceProfileName :: Lens' AddRoleToInstanceProfile Text Source #

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

addRoleToInstanceProfile_roleName :: Lens' AddRoleToInstanceProfile Text Source #

The name of the role to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

ListGroupsForUser

listGroupsForUser_marker :: Lens' ListGroupsForUser (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listGroupsForUser_maxItems :: Lens' ListGroupsForUser (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listGroupsForUser_userName :: Lens' ListGroupsForUser Text Source #

The name of the user to list groups for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listGroupsForUserResponse_marker :: Lens' ListGroupsForUserResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listGroupsForUserResponse_isTruncated :: Lens' ListGroupsForUserResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

ListEntitiesForPolicy

listEntitiesForPolicy_pathPrefix :: Lens' ListEntitiesForPolicy (Maybe Text) Source #

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listEntitiesForPolicy_entityFilter :: Lens' ListEntitiesForPolicy (Maybe EntityType) Source #

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. The argument for this parameter must be one of the valid values listed below.

listEntitiesForPolicy_marker :: Lens' ListEntitiesForPolicy (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listEntitiesForPolicy_maxItems :: Lens' ListEntitiesForPolicy (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listEntitiesForPolicy_policyUsageFilter :: Lens' ListEntitiesForPolicy (Maybe PolicyUsageType) Source #

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

listEntitiesForPolicy_policyArn :: Lens' ListEntitiesForPolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

listEntitiesForPolicyResponse_marker :: Lens' ListEntitiesForPolicyResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listEntitiesForPolicyResponse_isTruncated :: Lens' ListEntitiesForPolicyResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

AddUserToGroup

addUserToGroup_groupName :: Lens' AddUserToGroup Text Source #

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

addUserToGroup_userName :: Lens' AddUserToGroup Text Source #

The name of the user to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

TagOpenIDConnectProvider

tagOpenIDConnectProvider_openIDConnectProviderArn :: Lens' TagOpenIDConnectProvider Text Source #

The ARN of the OIDC identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagOpenIDConnectProvider_tags :: Lens' TagOpenIDConnectProvider [Tag] Source #

The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value.

SimulatePrincipalPolicy

simulatePrincipalPolicy_policyInputList :: Lens' SimulatePrincipalPolicy (Maybe [Text]) Source #

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

simulatePrincipalPolicy_resourcePolicy :: Lens' SimulatePrincipalPolicy (Maybe Text) Source #

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

simulatePrincipalPolicy_callerArn :: Lens' SimulatePrincipalPolicy (Maybe Text) Source #

The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

simulatePrincipalPolicy_resourceHandlingOption :: Lens' SimulatePrincipalPolicy (Maybe Text) Source #

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

  • EC2-Classic-InstanceStore

    instance, image, security group

  • EC2-Classic-EBS

    instance, image, security group, volume

  • EC2-VPC-InstanceStore

    instance, image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security group, network interface, subnet

  • EC2-VPC-EBS

    instance, image, security group, network interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security group, network interface, subnet, volume

simulatePrincipalPolicy_resourceArns :: Lens' SimulatePrincipalPolicy (Maybe [Text]) Source #

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

simulatePrincipalPolicy_permissionsBoundaryPolicyInputList :: Lens' SimulatePrincipalPolicy (Maybe [Text]) Source #

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

simulatePrincipalPolicy_marker :: Lens' SimulatePrincipalPolicy (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

simulatePrincipalPolicy_maxItems :: Lens' SimulatePrincipalPolicy (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

simulatePrincipalPolicy_contextEntries :: Lens' SimulatePrincipalPolicy (Maybe [ContextEntry]) Source #

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

simulatePrincipalPolicy_resourceOwner :: Lens' SimulatePrincipalPolicy (Maybe Text) Source #

An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

simulatePrincipalPolicy_policySourceArn :: Lens' SimulatePrincipalPolicy Text Source #

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

simulatePrincipalPolicy_actionNames :: Lens' SimulatePrincipalPolicy [Text] Source #

A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser.

simulatePolicyResponse_marker :: Lens' SimulatePolicyResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

simulatePolicyResponse_isTruncated :: Lens' SimulatePolicyResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

GetOrganizationsAccessReport

getOrganizationsAccessReport_sortKey :: Lens' GetOrganizationsAccessReport (Maybe SortKeyType) Source #

The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

getOrganizationsAccessReport_marker :: Lens' GetOrganizationsAccessReport (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getOrganizationsAccessReport_maxItems :: Lens' GetOrganizationsAccessReport (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getOrganizationsAccessReport_jobId :: Lens' GetOrganizationsAccessReport Text Source #

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

getOrganizationsAccessReportResponse_numberOfServicesNotAccessed :: Lens' GetOrganizationsAccessReportResponse (Maybe Int) Source #

The number of services that account principals are allowed but did not attempt to access.

getOrganizationsAccessReportResponse_jobCompletionDate :: Lens' GetOrganizationsAccessReportResponse (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

getOrganizationsAccessReportResponse_accessDetails :: Lens' GetOrganizationsAccessReportResponse (Maybe [AccessDetail]) Source #

An object that contains details about the most recent attempt to access the service.

getOrganizationsAccessReportResponse_numberOfServicesAccessible :: Lens' GetOrganizationsAccessReportResponse (Maybe Int) Source #

The number of services that the applicable SCPs allow account principals to access.

getOrganizationsAccessReportResponse_marker :: Lens' GetOrganizationsAccessReportResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getOrganizationsAccessReportResponse_isTruncated :: Lens' GetOrganizationsAccessReportResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

GetPolicyVersion

getPolicyVersion_policyArn :: Lens' GetPolicyVersion Text Source #

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

getPolicyVersion_versionId :: Lens' GetPolicyVersion Text Source #

Identifies the policy version to retrieve.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

getPolicyVersionResponse_policyVersion :: Lens' GetPolicyVersionResponse (Maybe PolicyVersion) Source #

A structure containing details about the policy version.

CreateServiceLinkedRole

createServiceLinkedRole_customSuffix :: Lens' CreateServiceLinkedRole (Maybe Text) Source #

A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix.

Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.

createServiceLinkedRole_aWSServiceName :: Lens' CreateServiceLinkedRole Text Source #

The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.

Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service.

createServiceLinkedRoleResponse_role :: Lens' CreateServiceLinkedRoleResponse (Maybe Role) Source #

A Role object that contains details about the newly created role.

ListServiceSpecificCredentials

listServiceSpecificCredentials_userName :: Lens' ListServiceSpecificCredentials (Maybe Text) Source #

The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listServiceSpecificCredentials_serviceName :: Lens' ListServiceSpecificCredentials (Maybe Text) Source #

Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services.

DeleteOpenIDConnectProvider

deleteOpenIDConnectProvider_openIDConnectProviderArn :: Lens' DeleteOpenIDConnectProvider Text Source #

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.

GetUser

getUser_userName :: Lens' GetUser (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getUserResponse_httpStatus :: Lens' GetUserResponse Int Source #

The response's http status code.

getUserResponse_user :: Lens' GetUserResponse User Source #

A structure containing details about the IAM user.

Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this operation. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate.

You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to Amazon Web Services in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access Amazon Web Services programmatically you can refer to access key last used information because it is accurate for all dates.

ListSigningCertificates

listSigningCertificates_userName :: Lens' ListSigningCertificates (Maybe Text) Source #

The name of the IAM user whose signing certificates you want to examine.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listSigningCertificates_marker :: Lens' ListSigningCertificates (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listSigningCertificates_maxItems :: Lens' ListSigningCertificates (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listSigningCertificatesResponse_marker :: Lens' ListSigningCertificatesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listSigningCertificatesResponse_isTruncated :: Lens' ListSigningCertificatesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

DeleteSigningCertificate

deleteSigningCertificate_userName :: Lens' DeleteSigningCertificate (Maybe Text) Source #

The name of the user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteSigningCertificate_certificateId :: Lens' DeleteSigningCertificate Text Source #

The ID of the signing certificate to delete.

The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.

UpdateSigningCertificate

updateSigningCertificate_userName :: Lens' UpdateSigningCertificate (Maybe Text) Source #

The name of the IAM user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateSigningCertificate_certificateId :: Lens' UpdateSigningCertificate Text Source #

The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

updateSigningCertificate_status :: Lens' UpdateSigningCertificate StatusType Source #

The status you want to assign to the certificate. Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used.

ListAttachedUserPolicies

listAttachedUserPolicies_pathPrefix :: Lens' ListAttachedUserPolicies (Maybe Text) Source #

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listAttachedUserPolicies_marker :: Lens' ListAttachedUserPolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listAttachedUserPolicies_maxItems :: Lens' ListAttachedUserPolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listAttachedUserPolicies_userName :: Lens' ListAttachedUserPolicies Text Source #

The name (friendly name, not ARN) of the user to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listAttachedUserPoliciesResponse_marker :: Lens' ListAttachedUserPoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listAttachedUserPoliciesResponse_isTruncated :: Lens' ListAttachedUserPoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

RemoveClientIDFromOpenIDConnectProvider

removeClientIDFromOpenIDConnectProvider_openIDConnectProviderArn :: Lens' RemoveClientIDFromOpenIDConnectProvider Text Source #

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

removeClientIDFromOpenIDConnectProvider_clientID :: Lens' RemoveClientIDFromOpenIDConnectProvider Text Source #

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

AttachUserPolicy

attachUserPolicy_userName :: Lens' AttachUserPolicy Text Source #

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

attachUserPolicy_policyArn :: Lens' AttachUserPolicy Text Source #

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

TagPolicy

tagPolicy_policyArn :: Lens' TagPolicy Text Source #

The ARN of the IAM customer managed policy to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagPolicy_tags :: Lens' TagPolicy [Tag] Source #

The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value.

CreateServiceSpecificCredential

createServiceSpecificCredential_userName :: Lens' CreateServiceSpecificCredential Text Source #

The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

createServiceSpecificCredential_serviceName :: Lens' CreateServiceSpecificCredential Text Source #

The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

createServiceSpecificCredentialResponse_serviceSpecificCredential :: Lens' CreateServiceSpecificCredentialResponse (Maybe ServiceSpecificCredential) Source #

A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

ListVirtualMFADevices

listVirtualMFADevices_assignmentStatus :: Lens' ListVirtualMFADevices (Maybe AssignmentStatusType) Source #

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

listVirtualMFADevices_marker :: Lens' ListVirtualMFADevices (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listVirtualMFADevices_maxItems :: Lens' ListVirtualMFADevices (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listVirtualMFADevicesResponse_marker :: Lens' ListVirtualMFADevicesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listVirtualMFADevicesResponse_isTruncated :: Lens' ListVirtualMFADevicesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listVirtualMFADevicesResponse_virtualMFADevices :: Lens' ListVirtualMFADevicesResponse [VirtualMFADevice] Source #

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

ResyncMFADevice

resyncMFADevice_userName :: Lens' ResyncMFADevice Text Source #

The name of the user whose MFA device you want to resynchronize.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

resyncMFADevice_serialNumber :: Lens' ResyncMFADevice Text Source #

Serial number that uniquely identifies the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

resyncMFADevice_authenticationCode1 :: Lens' ResyncMFADevice Text Source #

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

resyncMFADevice_authenticationCode2 :: Lens' ResyncMFADevice Text Source #

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

TagServerCertificate

tagServerCertificate_serverCertificateName :: Lens' TagServerCertificate Text Source #

The name of the IAM server certificate to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

tagServerCertificate_tags :: Lens' TagServerCertificate [Tag] Source #

The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

DeleteAccessKey

deleteAccessKey_userName :: Lens' DeleteAccessKey (Maybe Text) Source #

The name of the user whose access key pair you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteAccessKey_accessKeyId :: Lens' DeleteAccessKey AccessKey Source #

The access key ID for the access key ID and secret access key you want to delete.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

UpdateAccessKey

updateAccessKey_userName :: Lens' UpdateAccessKey (Maybe Text) Source #

The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateAccessKey_accessKeyId :: Lens' UpdateAccessKey AccessKey Source #

The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

updateAccessKey_status :: Lens' UpdateAccessKey StatusType Source #

The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

ListUserTags

listUserTags_marker :: Lens' ListUserTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listUserTags_maxItems :: Lens' ListUserTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listUserTags_userName :: Lens' ListUserTags Text Source #

The name of the IAM user whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listUserTagsResponse_marker :: Lens' ListUserTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listUserTagsResponse_isTruncated :: Lens' ListUserTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listUserTagsResponse_tags :: Lens' ListUserTagsResponse [Tag] Source #

The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

ListAccessKeys

listAccessKeys_userName :: Lens' ListAccessKeys (Maybe Text) Source #

The name of the user.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listAccessKeys_marker :: Lens' ListAccessKeys (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listAccessKeys_maxItems :: Lens' ListAccessKeys (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listAccessKeysResponse_marker :: Lens' ListAccessKeysResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listAccessKeysResponse_isTruncated :: Lens' ListAccessKeysResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listAccessKeysResponse_accessKeyMetadata :: Lens' ListAccessKeysResponse [AccessKeyMetadata] Source #

A list of objects containing metadata about the access keys.

GetRolePolicy

getRolePolicy_roleName :: Lens' GetRolePolicy Text Source #

The name of the role associated with the policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getRolePolicy_policyName :: Lens' GetRolePolicy Text Source #

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getRolePolicyResponse_roleName :: Lens' GetRolePolicyResponse Text Source #

The role the policy is associated with.

getRolePolicyResponse_policyDocument :: Lens' GetRolePolicyResponse Text Source #

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

SetSecurityTokenServicePreferences

setSecurityTokenServicePreferences_globalEndpointTokenVersion :: Lens' SetSecurityTokenServicePreferences GlobalEndpointTokenVersion Source #

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

UntagRole

untagRole_roleName :: Lens' UntagRole Text Source #

The name of the IAM role from which you want to remove tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagRole_tagKeys :: Lens' UntagRole [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role.

CreateUser

createUser_path :: Lens' CreateUser (Maybe Text) Source #

The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

createUser_permissionsBoundary :: Lens' CreateUser (Maybe Text) Source #

The ARN of the policy that is used to set the permissions boundary for the user.

createUser_tags :: Lens' CreateUser (Maybe [Tag]) Source #

A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createUser_userName :: Lens' CreateUser Text Source #

The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

createUserResponse_user :: Lens' CreateUserResponse (Maybe User) Source #

A structure with details about the new IAM user.

PutRolePolicy

putRolePolicy_roleName :: Lens' PutRolePolicy Text Source #

The name of the role to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

putRolePolicy_policyName :: Lens' PutRolePolicy Text Source #

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

putRolePolicy_policyDocument :: Lens' PutRolePolicy Text Source #

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

GetContextKeysForCustomPolicy

getContextKeysForCustomPolicy_policyInputList :: Lens' GetContextKeysForCustomPolicy [Text] Source #

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

getContextKeysForPolicyResponse_contextKeyNames :: Lens' GetContextKeysForPolicyResponse (Maybe [Text]) Source #

The list of context keys that are referenced in the input policies.

UploadSigningCertificate

uploadSigningCertificate_userName :: Lens' UploadSigningCertificate (Maybe Text) Source #

The name of the user the signing certificate is for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

uploadSigningCertificate_certificateBody :: Lens' UploadSigningCertificate Text Source #

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

DeleteRolePolicy

deleteRolePolicy_roleName :: Lens' DeleteRolePolicy Text Source #

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

deleteRolePolicy_policyName :: Lens' DeleteRolePolicy Text Source #

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

GetAccountPasswordPolicy

getAccountPasswordPolicyResponse_passwordPolicy :: Lens' GetAccountPasswordPolicyResponse PasswordPolicy Source #

A structure that contains details about the account's password policy.

GetAccessKeyLastUsed

getAccessKeyLastUsed_accessKeyId :: Lens' GetAccessKeyLastUsed AccessKey Source #

The identifier of an access key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

getAccessKeyLastUsedResponse_userName :: Lens' GetAccessKeyLastUsedResponse (Maybe Text) Source #

The name of the IAM user that owns this access key.

getAccessKeyLastUsedResponse_accessKeyLastUsed :: Lens' GetAccessKeyLastUsedResponse (Maybe AccessKeyLastUsed) Source #

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

UpdateUser

updateUser_newUserName :: Lens' UpdateUser (Maybe Text) Source #

New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

updateUser_newPath :: Lens' UpdateUser (Maybe Text) Source #

New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

updateUser_userName :: Lens' UpdateUser Text Source #

Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

DeleteUser

deleteUser_userName :: Lens' DeleteUser Text Source #

The name of the user to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

AddClientIDToOpenIDConnectProvider

addClientIDToOpenIDConnectProvider_openIDConnectProviderArn :: Lens' AddClientIDToOpenIDConnectProvider Text Source #

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

addClientIDToOpenIDConnectProvider_clientID :: Lens' AddClientIDToOpenIDConnectProvider Text Source #

The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

ListRolePolicies

listRolePolicies_marker :: Lens' ListRolePolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listRolePolicies_maxItems :: Lens' ListRolePolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listRolePolicies_roleName :: Lens' ListRolePolicies Text Source #

The name of the role to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listRolePoliciesResponse_marker :: Lens' ListRolePoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listRolePoliciesResponse_isTruncated :: Lens' ListRolePoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

CreateAccountAlias

createAccountAlias_accountAlias :: Lens' CreateAccountAlias Text Source #

The account alias to create.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

ListPoliciesGrantingServiceAccess

listPoliciesGrantingServiceAccess_marker :: Lens' ListPoliciesGrantingServiceAccess (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listPoliciesGrantingServiceAccess_arn :: Lens' ListPoliciesGrantingServiceAccess Text Source #

The ARN of the IAM identity (user, group, or role) whose policies you want to list.

listPoliciesGrantingServiceAccess_serviceNamespaces :: Lens' ListPoliciesGrantingServiceAccess (NonEmpty Text) Source #

The service namespace for the Amazon Web Services services whose policies you want to list.

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

listPoliciesGrantingServiceAccessResponse_marker :: Lens' ListPoliciesGrantingServiceAccessResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listPoliciesGrantingServiceAccessResponse_isTruncated :: Lens' ListPoliciesGrantingServiceAccessResponse (Maybe Bool) Source #

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. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listPoliciesGrantingServiceAccessResponse_policiesGrantingServiceAccess :: Lens' ListPoliciesGrantingServiceAccessResponse [ListPoliciesGrantingServiceAccessEntry] Source #

ListPoliciesGrantingServiceAccess object that contains details about the permissions policies attached to the specified identity (user, group, or role).

ListInstanceProfiles

listInstanceProfiles_pathPrefix :: Lens' ListInstanceProfiles (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listInstanceProfiles_marker :: Lens' ListInstanceProfiles (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listInstanceProfiles_maxItems :: Lens' ListInstanceProfiles (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listInstanceProfilesResponse_marker :: Lens' ListInstanceProfilesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listInstanceProfilesResponse_isTruncated :: Lens' ListInstanceProfilesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

EnableMFADevice

enableMFADevice_userName :: Lens' EnableMFADevice Text Source #

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

enableMFADevice_serialNumber :: Lens' EnableMFADevice Text Source #

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

enableMFADevice_authenticationCode1 :: Lens' EnableMFADevice Text Source #

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

enableMFADevice_authenticationCode2 :: Lens' EnableMFADevice Text Source #

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

ListAccountAliases

listAccountAliases_marker :: Lens' ListAccountAliases (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listAccountAliases_maxItems :: Lens' ListAccountAliases (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listAccountAliasesResponse_marker :: Lens' ListAccountAliasesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listAccountAliasesResponse_isTruncated :: Lens' ListAccountAliasesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listAccountAliasesResponse_accountAliases :: Lens' ListAccountAliasesResponse [Text] Source #

A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

DeleteSAMLProvider

deleteSAMLProvider_sAMLProviderArn :: Lens' DeleteSAMLProvider Text Source #

The Amazon Resource Name (ARN) of the SAML provider to delete.

UpdateSAMLProvider

updateSAMLProvider_sAMLMetadataDocument :: Lens' UpdateSAMLProvider Text Source #

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.

updateSAMLProvider_sAMLProviderArn :: Lens' UpdateSAMLProvider Text Source #

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

updateSAMLProviderResponse_sAMLProviderArn :: Lens' UpdateSAMLProviderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SAML provider that was updated.

UntagMFADevice

untagMFADevice_serialNumber :: Lens' UntagMFADevice Text Source #

The unique identifier for the IAM virtual MFA device from which you want to remove tags. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagMFADevice_tagKeys :: Lens' UntagMFADevice [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

CreateGroup

createGroup_path :: Lens' CreateGroup (Maybe Text) Source #

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

createGroup_groupName :: Lens' CreateGroup Text Source #

The name of the group to create. Do not include the path in this value.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

createGroupResponse_group :: Lens' CreateGroupResponse Group Source #

A structure containing details about the new group.

ListMFADevices

listMFADevices_userName :: Lens' ListMFADevices (Maybe Text) Source #

The name of the user whose MFA devices you want to list.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listMFADevices_marker :: Lens' ListMFADevices (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listMFADevices_maxItems :: Lens' ListMFADevices (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listMFADevicesResponse_marker :: Lens' ListMFADevicesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listMFADevicesResponse_isTruncated :: Lens' ListMFADevicesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

UntagInstanceProfile

untagInstanceProfile_instanceProfileName :: Lens' UntagInstanceProfile Text Source #

The name of the IAM instance profile from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagInstanceProfile_tagKeys :: Lens' UntagInstanceProfile [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

UploadServerCertificate

uploadServerCertificate_path :: Lens' UploadServerCertificate (Maybe Text) Source #

The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).

uploadServerCertificate_certificateChain :: Lens' UploadServerCertificate (Maybe Text) Source #

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

uploadServerCertificate_tags :: Lens' UploadServerCertificate (Maybe [Tag]) Source #

A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

uploadServerCertificate_serverCertificateName :: Lens' UploadServerCertificate Text Source #

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

uploadServerCertificate_certificateBody :: Lens' UploadServerCertificate Text Source #

The contents of the public key certificate in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

uploadServerCertificate_privateKey :: Lens' UploadServerCertificate Text Source #

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

uploadServerCertificateResponse_serverCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata) Source #

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

uploadServerCertificateResponse_tags :: Lens' UploadServerCertificateResponse (Maybe [Tag]) Source #

A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

SetDefaultPolicyVersion

setDefaultPolicyVersion_policyArn :: Lens' SetDefaultPolicyVersion Text Source #

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

setDefaultPolicyVersion_versionId :: Lens' SetDefaultPolicyVersion Text Source #

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 IAM User Guide.

ListPolicyVersions

listPolicyVersions_marker :: Lens' ListPolicyVersions (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listPolicyVersions_maxItems :: Lens' ListPolicyVersions (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listPolicyVersions_policyArn :: Lens' ListPolicyVersions Text Source #

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

listPolicyVersionsResponse_versions :: Lens' ListPolicyVersionsResponse (Maybe [PolicyVersion]) Source #

A list of policy versions.

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

listPolicyVersionsResponse_marker :: Lens' ListPolicyVersionsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listPolicyVersionsResponse_isTruncated :: Lens' ListPolicyVersionsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

UpdateRoleDescription

updateRoleDescription_roleName :: Lens' UpdateRoleDescription Text Source #

The name of the role that you want to modify.

updateRoleDescription_description :: Lens' UpdateRoleDescription Text Source #

The new description that you want to apply to the specified role.

updateRoleDescriptionResponse_role :: Lens' UpdateRoleDescriptionResponse (Maybe Role) Source #

A structure that contains details about the modified role.

ListSAMLProviders

listSAMLProvidersResponse_sAMLProviderList :: Lens' ListSAMLProvidersResponse (Maybe [SAMLProviderListEntry]) Source #

The list of SAML provider resource objects defined in IAM for this Amazon Web Services account.

GetServiceLastAccessedDetails

getServiceLastAccessedDetails_marker :: Lens' GetServiceLastAccessedDetails (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getServiceLastAccessedDetails_maxItems :: Lens' GetServiceLastAccessedDetails (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getServiceLastAccessedDetails_jobId :: Lens' GetServiceLastAccessedDetails Text Source #

The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

getServiceLastAccessedDetailsResponse_jobType :: Lens' GetServiceLastAccessedDetailsResponse (Maybe AccessAdvisorUsageGranularityType) Source #

The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed.

getServiceLastAccessedDetailsResponse_error :: Lens' GetServiceLastAccessedDetailsResponse (Maybe ErrorDetails) Source #

An object that contains details about the reason the operation failed.

getServiceLastAccessedDetailsResponse_marker :: Lens' GetServiceLastAccessedDetailsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getServiceLastAccessedDetailsResponse_isTruncated :: Lens' GetServiceLastAccessedDetailsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

getServiceLastAccessedDetailsResponse_servicesLastAccessed :: Lens' GetServiceLastAccessedDetailsResponse [ServiceLastAccessed] Source #

ServiceLastAccessed object that contains details about the most recent attempt to access the service.

getServiceLastAccessedDetailsResponse_jobCompletionDate :: Lens' GetServiceLastAccessedDetailsResponse UTCTime Source #

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

GetServerCertificate

getServerCertificate_serverCertificateName :: Lens' GetServerCertificate Text Source #

The name of the server certificate you want to retrieve information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

DeleteGroup

deleteGroup_groupName :: Lens' DeleteGroup Text Source #

The name of the IAM group to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

UpdateGroup

updateGroup_newGroupName :: Lens' UpdateGroup (Maybe Text) Source #

New name for the IAM group. Only include this if changing the group's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

updateGroup_newPath :: Lens' UpdateGroup (Maybe Text) Source #

New path for the IAM group. Only include this if changing the group's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

updateGroup_groupName :: Lens' UpdateGroup Text Source #

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

ListGroups

listGroups_pathPrefix :: Lens' ListGroups (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listGroups_marker :: Lens' ListGroups (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listGroups_maxItems :: Lens' ListGroups (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listGroupsResponse_marker :: Lens' ListGroupsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listGroupsResponse_isTruncated :: Lens' ListGroupsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

GenerateCredentialReport

GetPolicy

getPolicy_policyArn :: Lens' GetPolicy Text Source #

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

getPolicyResponse_policy :: Lens' GetPolicyResponse (Maybe Policy) Source #

A structure containing details about the policy.

getPolicyResponse_httpStatus :: Lens' GetPolicyResponse Int Source #

The response's http status code.

ListInstanceProfileTags

listInstanceProfileTags_marker :: Lens' ListInstanceProfileTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listInstanceProfileTags_maxItems :: Lens' ListInstanceProfileTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listInstanceProfileTags_instanceProfileName :: Lens' ListInstanceProfileTags Text Source #

The name of the IAM instance profile whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listInstanceProfileTagsResponse_marker :: Lens' ListInstanceProfileTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listInstanceProfileTagsResponse_isTruncated :: Lens' ListInstanceProfileTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listInstanceProfileTagsResponse_tags :: Lens' ListInstanceProfileTagsResponse [Tag] Source #

The list of tags that are currently attached to the IAM instance profile. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

UpdateLoginProfile

updateLoginProfile_password :: Lens' UpdateLoginProfile (Maybe Text) Source #

The new password for the specified IAM user.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

updateLoginProfile_passwordResetRequired :: Lens' UpdateLoginProfile (Maybe Bool) Source #

Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

updateLoginProfile_userName :: Lens' UpdateLoginProfile Text Source #

The name of the user whose password you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

DeleteLoginProfile

deleteLoginProfile_userName :: Lens' DeleteLoginProfile Text Source #

The name of the user whose password you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

ListSAMLProviderTags

listSAMLProviderTags_marker :: Lens' ListSAMLProviderTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listSAMLProviderTags_maxItems :: Lens' ListSAMLProviderTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listSAMLProviderTags_sAMLProviderArn :: Lens' ListSAMLProviderTags Text Source #

The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listSAMLProviderTagsResponse_marker :: Lens' ListSAMLProviderTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listSAMLProviderTagsResponse_isTruncated :: Lens' ListSAMLProviderTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listSAMLProviderTagsResponse_tags :: Lens' ListSAMLProviderTagsResponse [Tag] Source #

The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

GetGroup

getGroup_marker :: Lens' GetGroup (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getGroup_maxItems :: Lens' GetGroup (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getGroup_groupName :: Lens' GetGroup Text Source #

The name of the group.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

getGroupResponse_marker :: Lens' GetGroupResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getGroupResponse_isTruncated :: Lens' GetGroupResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

getGroupResponse_httpStatus :: Lens' GetGroupResponse Int Source #

The response's http status code.

getGroupResponse_group :: Lens' GetGroupResponse Group Source #

A structure that contains details about the group.

getGroupResponse_users :: Lens' GetGroupResponse [User] Source #

A list of users in the group.

UntagPolicy

untagPolicy_policyArn :: Lens' UntagPolicy Text Source #

The ARN of the IAM customer managed policy from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

untagPolicy_tagKeys :: Lens' UntagPolicy [Text] Source #

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy.

DeleteServerCertificate

deleteServerCertificate_serverCertificateName :: Lens' DeleteServerCertificate Text Source #

The name of the server certificate you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

UpdateServerCertificate

updateServerCertificate_newServerCertificateName :: Lens' UpdateServerCertificate (Maybe Text) Source #

The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateServerCertificate_newPath :: Lens' UpdateServerCertificate (Maybe Text) Source #

The new path for the server certificate. Include this only if you are updating the server certificate's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

updateServerCertificate_serverCertificateName :: Lens' UpdateServerCertificate Text Source #

The name of the server certificate that you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

ListAttachedGroupPolicies

listAttachedGroupPolicies_pathPrefix :: Lens' ListAttachedGroupPolicies (Maybe Text) Source #

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listAttachedGroupPolicies_marker :: Lens' ListAttachedGroupPolicies (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listAttachedGroupPolicies_maxItems :: Lens' ListAttachedGroupPolicies (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listAttachedGroupPolicies_groupName :: Lens' ListAttachedGroupPolicies Text Source #

The name (friendly name, not ARN) of the group to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listAttachedGroupPoliciesResponse_marker :: Lens' ListAttachedGroupPoliciesResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listAttachedGroupPoliciesResponse_isTruncated :: Lens' ListAttachedGroupPoliciesResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

ListMFADeviceTags

listMFADeviceTags_marker :: Lens' ListMFADeviceTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listMFADeviceTags_maxItems :: Lens' ListMFADeviceTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listMFADeviceTags_serialNumber :: Lens' ListMFADeviceTags Text Source #

The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

listMFADeviceTagsResponse_marker :: Lens' ListMFADeviceTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listMFADeviceTagsResponse_isTruncated :: Lens' ListMFADeviceTagsResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listMFADeviceTagsResponse_tags :: Lens' ListMFADeviceTagsResponse [Tag] Source #

The list of tags that are currently attached to the virtual MFA device. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

Types

AccessDetail

accessDetail_entityPath :: Lens' AccessDetail (Maybe Text) Source #

The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no principals (IAM users, IAM roles, or root users) in the reported Organizations entity attempted to access the service within the reporting period.

accessDetail_region :: Lens' AccessDetail (Maybe Text) Source #

The Region where the last service access attempt occurred.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

accessDetail_lastAuthenticatedTime :: Lens' AccessDetail (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

accessDetail_totalAuthenticatedEntities :: Lens' AccessDetail (Maybe Int) Source #

The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to access the service in the reporting period.

accessDetail_serviceName :: Lens' AccessDetail Text Source #

The name of the service in which access was attempted.

accessDetail_serviceNamespace :: Lens' AccessDetail Text Source #

The namespace of the service in which access was attempted.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

AccessKeyInfo

accessKeyInfo_createDate :: Lens' AccessKeyInfo (Maybe UTCTime) Source #

The date when the access key was created.

accessKeyInfo_userName :: Lens' AccessKeyInfo Text Source #

The name of the IAM user that the access key is associated with.

accessKeyInfo_status :: Lens' AccessKeyInfo StatusType Source #

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

accessKeyInfo_secretAccessKey :: Lens' AccessKeyInfo Text Source #

The secret key used to sign requests.

AccessKeyLastUsed

accessKeyLastUsed_lastUsedDate :: Lens' AccessKeyLastUsed UTCTime Source #

The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations:

  • The user does not have an access key.
  • An access key exists but has not been used since IAM began tracking this information.
  • There is no sign-in data associated with the user.

accessKeyLastUsed_serviceName :: Lens' AccessKeyLastUsed Text Source #

The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is "N/A" in the following situations:

  • The user does not have an access key.
  • An access key exists but has not been used since IAM started tracking this information.
  • There is no sign-in data associated with the user.

accessKeyLastUsed_region :: Lens' AccessKeyLastUsed Text Source #

The Amazon Web Services Region where this access key was most recently used. The value for this field is "N/A" in the following situations:

  • The user does not have an access key.
  • An access key exists but has not been used since IAM began tracking this information.
  • There is no sign-in data associated with the user.

For more information about Amazon Web Services Regions, see Regions and endpoints in the Amazon Web Services General Reference.

AccessKeyMetadata

accessKeyMetadata_status :: Lens' AccessKeyMetadata (Maybe StatusType) Source #

The status of the access key. Active means that the key is valid for API calls; Inactive means it is not.

accessKeyMetadata_createDate :: Lens' AccessKeyMetadata (Maybe UTCTime) Source #

The date when the access key was created.

accessKeyMetadata_userName :: Lens' AccessKeyMetadata (Maybe Text) Source #

The name of the IAM user that the key is associated with.

AttachedPermissionsBoundary

attachedPermissionsBoundary_permissionsBoundaryType :: Lens' AttachedPermissionsBoundary (Maybe PermissionsBoundaryAttachmentType) Source #

The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.

attachedPermissionsBoundary_permissionsBoundaryArn :: Lens' AttachedPermissionsBoundary (Maybe Text) Source #

The ARN of the policy used to set the permissions boundary for the user or role.

AttachedPolicy

attachedPolicy_policyName :: Lens' AttachedPolicy (Maybe Text) Source #

The friendly name of the attached policy.

ContextEntry

contextEntry_contextKeyValues :: Lens' ContextEntry (Maybe [Text]) Source #

The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.

contextEntry_contextKeyName :: Lens' ContextEntry (Maybe Text) Source #

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

contextEntry_contextKeyType :: Lens' ContextEntry (Maybe ContextKeyTypeEnum) Source #

The data type of the value (or values) specified in the ContextKeyValues parameter.

DeletionTaskFailureReasonType

deletionTaskFailureReasonType_roleUsageList :: Lens' DeletionTaskFailureReasonType (Maybe [RoleUsageType]) Source #

A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used.

deletionTaskFailureReasonType_reason :: Lens' DeletionTaskFailureReasonType (Maybe Text) Source #

A short description of the reason that the service-linked role deletion failed.

EntityDetails

entityDetails_lastAuthenticated :: Lens' EntityDetails (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

entityDetails_entityInfo :: Lens' EntityDetails EntityInfo Source #

The EntityInfo object that contains details about the entity (user or role).

EntityInfo

entityInfo_path :: Lens' EntityInfo (Maybe Text) Source #

The path to the entity (user or role). For more information about paths, see IAM identifiers in the IAM User Guide.

entityInfo_arn :: Lens' EntityInfo Text Source #

Undocumented member.

entityInfo_name :: Lens' EntityInfo Text Source #

The name of the entity (user or role).

entityInfo_type :: Lens' EntityInfo PolicyOwnerEntityType Source #

The type of entity (user or role).

entityInfo_id :: Lens' EntityInfo Text Source #

The identifier of the entity (user or role).

ErrorDetails

errorDetails_message :: Lens' ErrorDetails Text Source #

Detailed information about the reason that the operation failed.

errorDetails_code :: Lens' ErrorDetails Text Source #

The error code associated with the operation failure.

EvaluationResult

evaluationResult_matchedStatements :: Lens' EvaluationResult (Maybe [Statement]) Source #

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

evaluationResult_evalDecisionDetails :: Lens' EvaluationResult (Maybe (HashMap Text PolicyEvaluationDecisionType)) Source #

Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.

If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned.

When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account.

If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.

evaluationResult_resourceSpecificResults :: Lens' EvaluationResult (Maybe [ResourceSpecificResult]) Source #

The individual results of the simulation of the API operation specified in EvalActionName on each resource.

evaluationResult_evalResourceName :: Lens' EvaluationResult (Maybe Text) Source #

The ARN of the resource that the indicated API operation was tested on.

evaluationResult_missingContextValues :: Lens' EvaluationResult (Maybe [Text]) Source #

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

evaluationResult_permissionsBoundaryDecisionDetail :: Lens' EvaluationResult (Maybe PermissionsBoundaryDecisionDetail) Source #

Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

evaluationResult_organizationsDecisionDetail :: Lens' EvaluationResult (Maybe OrganizationsDecisionDetail) Source #

A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.

evaluationResult_evalActionName :: Lens' EvaluationResult Text Source #

The name of the API operation tested on the indicated resource.

GetContextKeysForPolicyResponse

getContextKeysForPolicyResponse_contextKeyNames :: Lens' GetContextKeysForPolicyResponse (Maybe [Text]) Source #

The list of context keys that are referenced in the input policies.

Group

group_path :: Lens' Group Text Source #

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

group_groupName :: Lens' Group Text Source #

The friendly name that identifies the group.

group_groupId :: Lens' Group Text Source #

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

group_arn :: Lens' Group Text Source #

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 IAM User Guide.

group_createDate :: Lens' Group UTCTime Source #

The date and time, in ISO 8601 date-time format, when the group was created.

GroupDetail

groupDetail_path :: Lens' GroupDetail (Maybe Text) Source #

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

groupDetail_createDate :: Lens' GroupDetail (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the group was created.

groupDetail_groupId :: Lens' GroupDetail (Maybe Text) Source #

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

groupDetail_groupPolicyList :: Lens' GroupDetail (Maybe [PolicyDetail]) Source #

A list of the inline policies embedded in the group.

groupDetail_groupName :: Lens' GroupDetail (Maybe Text) Source #

The friendly name that identifies the group.

groupDetail_attachedManagedPolicies :: Lens' GroupDetail (Maybe [AttachedPolicy]) Source #

A list of the managed policies attached to the group.

InstanceProfile

instanceProfile_tags :: Lens' InstanceProfile (Maybe [Tag]) Source #

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

instanceProfile_path :: Lens' InstanceProfile Text Source #

The path to the instance profile. For more information about paths, see IAM identifiers in the IAM User Guide.

instanceProfile_instanceProfileName :: Lens' InstanceProfile Text Source #

The name identifying the instance profile.

instanceProfile_instanceProfileId :: Lens' InstanceProfile Text Source #

The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the IAM User Guide.

instanceProfile_arn :: Lens' InstanceProfile Text Source #

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 IAM User Guide.

instanceProfile_createDate :: Lens' InstanceProfile UTCTime Source #

The date when the instance profile was created.

instanceProfile_roles :: Lens' InstanceProfile [Role] Source #

The role associated with the instance profile.

ListPoliciesGrantingServiceAccessEntry

listPoliciesGrantingServiceAccessEntry_serviceNamespace :: Lens' ListPoliciesGrantingServiceAccessEntry (Maybe Text) Source #

The namespace of the service that was accessed.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

listPoliciesGrantingServiceAccessEntry_policies :: Lens' ListPoliciesGrantingServiceAccessEntry (Maybe [PolicyGrantingServiceAccess]) Source #

The PoliciesGrantingServiceAccess object that contains details about the policy.

LoginProfile

loginProfile_passwordResetRequired :: Lens' LoginProfile (Maybe Bool) Source #

Specifies whether the user is required to set a new password on next sign-in.

loginProfile_userName :: Lens' LoginProfile Text Source #

The name of the user, which can be used for signing in to the Amazon Web Services Management Console.

loginProfile_createDate :: Lens' LoginProfile UTCTime Source #

The date when the password for the user was created.

MFADevice

mfaDevice_userName :: Lens' MFADevice Text Source #

The user with whom the MFA device is associated.

mfaDevice_serialNumber :: Lens' MFADevice Text Source #

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

mfaDevice_enableDate :: Lens' MFADevice UTCTime Source #

The date when the MFA device was enabled for the user.

ManagedPolicyDetail

managedPolicyDetail_policyName :: Lens' ManagedPolicyDetail (Maybe Text) Source #

The friendly name (not ARN) identifying the policy.

managedPolicyDetail_updateDate :: Lens' ManagedPolicyDetail (Maybe UTCTime) Source #

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.

managedPolicyDetail_policyId :: Lens' ManagedPolicyDetail (Maybe Text) Source #

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

managedPolicyDetail_path :: Lens' ManagedPolicyDetail (Maybe Text) Source #

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

managedPolicyDetail_policyVersionList :: Lens' ManagedPolicyDetail (Maybe [PolicyVersion]) Source #

A list containing information about the versions of the policy.

managedPolicyDetail_isAttachable :: Lens' ManagedPolicyDetail (Maybe Bool) Source #

Specifies whether the policy can be attached to an IAM user, group, or role.

managedPolicyDetail_permissionsBoundaryUsageCount :: Lens' ManagedPolicyDetail (Maybe Int) Source #

The number of entities (users and roles) for which the policy is used as the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

managedPolicyDetail_defaultVersionId :: Lens' ManagedPolicyDetail (Maybe Text) Source #

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 IAM User Guide.

managedPolicyDetail_attachmentCount :: Lens' ManagedPolicyDetail (Maybe Int) Source #

The number of principal entities (users, groups, and roles) that the policy is attached to.

managedPolicyDetail_description :: Lens' ManagedPolicyDetail (Maybe Text) Source #

A friendly description of the policy.

OpenIDConnectProviderListEntry

OrganizationsDecisionDetail

organizationsDecisionDetail_allowedByOrganizations :: Lens' OrganizationsDecisionDetail (Maybe Bool) Source #

Specifies whether the simulated operation is allowed by the Organizations service control policies that impact the simulated user's account.

PasswordPolicy

passwordPolicy_expirePasswords :: Lens' PasswordPolicy (Maybe Bool) Source #

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

passwordPolicy_minimumPasswordLength :: Lens' PasswordPolicy (Maybe Natural) Source #

Minimum length to require for IAM user passwords.

passwordPolicy_requireNumbers :: Lens' PasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

passwordPolicy_passwordReusePrevention :: Lens' PasswordPolicy (Maybe Natural) Source #

Specifies the number of previous passwords that IAM users are prevented from reusing.

passwordPolicy_requireLowercaseCharacters :: Lens' PasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one lowercase character (a to z).

passwordPolicy_maxPasswordAge :: Lens' PasswordPolicy (Maybe Natural) Source #

The number of days that an IAM user password is valid.

passwordPolicy_hardExpiry :: Lens' PasswordPolicy (Maybe Bool) Source #

Specifies whether IAM users are prevented from setting a new password after their password has expired.

passwordPolicy_requireSymbols :: Lens' PasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one of the following symbols:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

passwordPolicy_requireUppercaseCharacters :: Lens' PasswordPolicy (Maybe Bool) Source #

Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

passwordPolicy_allowUsersToChangePassword :: Lens' PasswordPolicy (Maybe Bool) Source #

Specifies whether IAM users are allowed to change their own password.

PermissionsBoundaryDecisionDetail

permissionsBoundaryDecisionDetail_allowedByPermissionsBoundary :: Lens' PermissionsBoundaryDecisionDetail (Maybe Bool) Source #

Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role). A value of true means that the permissions boundary does not deny the action. This means that the policy includes an Allow statement that matches the request. In this case, if an identity-based policy also allows the action, the request is allowed. A value of false means that either the requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.

Policy

policy_policyName :: Lens' Policy (Maybe Text) Source #

The friendly name (not ARN) identifying the policy.

policy_arn :: Lens' Policy (Maybe Text) Source #

Undocumented member.

policy_updateDate :: Lens' Policy (Maybe UTCTime) Source #

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_policyId :: Lens' Policy (Maybe Text) Source #

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

policy_path :: Lens' Policy (Maybe Text) Source #

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

policy_createDate :: Lens' Policy (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the policy was created.

policy_isAttachable :: Lens' Policy (Maybe Bool) Source #

Specifies whether the policy can be attached to an IAM user, group, or role.

policy_permissionsBoundaryUsageCount :: Lens' Policy (Maybe Int) Source #

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

policy_defaultVersionId :: Lens' Policy (Maybe Text) Source #

The identifier for the version of the policy that is set as the default version.

policy_attachmentCount :: Lens' Policy (Maybe Int) Source #

The number of entities (users, groups, and roles) that the policy is attached to.

policy_description :: Lens' Policy (Maybe Text) Source #

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.

policy_tags :: Lens' Policy (Maybe [Tag]) Source #

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

PolicyDetail

PolicyGrantingServiceAccess

policyGrantingServiceAccess_entityName :: Lens' PolicyGrantingServiceAccess (Maybe Text) Source #

The name of the entity (user or role) to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

policyGrantingServiceAccess_entityType :: Lens' PolicyGrantingServiceAccess (Maybe PolicyOwnerEntityType) Source #

The type of entity (user or role) that used the policy to access the service to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

policyGrantingServiceAccess_policyType :: Lens' PolicyGrantingServiceAccess PolicyType Source #

The policy type. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

PolicyGroup

policyGroup_groupId :: Lens' PolicyGroup (Maybe Text) Source #

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

policyGroup_groupName :: Lens' PolicyGroup (Maybe Text) Source #

The name (friendly name, not ARN) identifying the group.

PolicyRole

policyRole_roleName :: Lens' PolicyRole (Maybe Text) Source #

The name (friendly name, not ARN) identifying the role.

policyRole_roleId :: Lens' PolicyRole (Maybe Text) Source #

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

PolicyUser

policyUser_userName :: Lens' PolicyUser (Maybe Text) Source #

The name (friendly name, not ARN) identifying the user.

policyUser_userId :: Lens' PolicyUser (Maybe Text) Source #

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

PolicyVersion

policyVersion_versionId :: Lens' PolicyVersion (Maybe Text) Source #

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.

policyVersion_createDate :: Lens' PolicyVersion (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the policy version was created.

policyVersion_document :: Lens' PolicyVersion (Maybe Text) Source #

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

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

policyVersion_isDefaultVersion :: Lens' PolicyVersion (Maybe Bool) Source #

Specifies whether the policy version is set as the policy's default version.

Position

position_line :: Lens' Position (Maybe Int) Source #

The line containing the specified position in the document.

position_column :: Lens' Position (Maybe Int) Source #

The column in the line containing the specified position in the document.

ResourceSpecificResult

resourceSpecificResult_matchedStatements :: Lens' ResourceSpecificResult (Maybe [Statement]) Source #

A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

resourceSpecificResult_evalDecisionDetails :: Lens' ResourceSpecificResult (Maybe (HashMap Text PolicyEvaluationDecisionType)) Source #

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

resourceSpecificResult_missingContextValues :: Lens' ResourceSpecificResult (Maybe [Text]) Source #

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

resourceSpecificResult_permissionsBoundaryDecisionDetail :: Lens' ResourceSpecificResult (Maybe PermissionsBoundaryDecisionDetail) Source #

Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity.

resourceSpecificResult_evalResourceName :: Lens' ResourceSpecificResult Text Source #

The name of the simulated resource, in Amazon Resource Name (ARN) format.

resourceSpecificResult_evalResourceDecision :: Lens' ResourceSpecificResult PolicyEvaluationDecisionType Source #

The result of the simulation of the simulated API operation on the resource specified in EvalResourceName.

Role

role_maxSessionDuration :: Lens' Role (Maybe Natural) Source #

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

role_assumeRolePolicyDocument :: Lens' Role (Maybe Text) Source #

The policy that grants an entity permission to assume the role.

role_roleLastUsed :: Lens' Role (Maybe RoleLastUsed) Source #

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.

role_permissionsBoundary :: Lens' Role (Maybe AttachedPermissionsBoundary) Source #

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

role_description :: Lens' Role (Maybe Text) Source #

A description of the role that you provide.

role_tags :: Lens' Role (Maybe [Tag]) Source #

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

role_path :: Lens' Role Text Source #

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

role_roleName :: Lens' Role Text Source #

The friendly name that identifies the role.

role_roleId :: Lens' Role Text Source #

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

role_arn :: Lens' Role Text Source #

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 IAM User Guide guide.

role_createDate :: Lens' Role UTCTime Source #

The date and time, in ISO 8601 date-time format, when the role was created.

RoleDetail

roleDetail_assumeRolePolicyDocument :: Lens' RoleDetail (Maybe Text) Source #

The trust policy that grants permission to assume the role.

roleDetail_arn :: Lens' RoleDetail (Maybe Text) Source #

Undocumented member.

roleDetail_path :: Lens' RoleDetail (Maybe Text) Source #

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

roleDetail_instanceProfileList :: Lens' RoleDetail (Maybe [InstanceProfile]) Source #

A list of instance profiles that contain this role.

roleDetail_createDate :: Lens' RoleDetail (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the role was created.

roleDetail_roleName :: Lens' RoleDetail (Maybe Text) Source #

The friendly name that identifies the role.

roleDetail_roleId :: Lens' RoleDetail (Maybe Text) Source #

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

roleDetail_roleLastUsed :: Lens' RoleDetail (Maybe RoleLastUsed) Source #

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.

roleDetail_permissionsBoundary :: Lens' RoleDetail (Maybe AttachedPermissionsBoundary) Source #

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

roleDetail_rolePolicyList :: Lens' RoleDetail (Maybe [PolicyDetail]) Source #

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

roleDetail_tags :: Lens' RoleDetail (Maybe [Tag]) Source #

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

roleDetail_attachedManagedPolicies :: Lens' RoleDetail (Maybe [AttachedPolicy]) Source #

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

RoleLastUsed

roleLastUsed_lastUsedDate :: Lens' RoleLastUsed (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format that the role was last used.

This field is null if the role has not been used within the IAM tracking period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.

roleLastUsed_region :: Lens' RoleLastUsed (Maybe Text) Source #

The name of the Amazon Web Services Region in which the role was last used.

RoleUsageType

roleUsageType_resources :: Lens' RoleUsageType (Maybe [Text]) Source #

The name of the resource that is using the service-linked role.

roleUsageType_region :: Lens' RoleUsageType (Maybe Text) Source #

The name of the Region where the service-linked role is being used.

SAMLProviderListEntry

sAMLProviderListEntry_arn :: Lens' SAMLProviderListEntry (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SAML provider.

sAMLProviderListEntry_createDate :: Lens' SAMLProviderListEntry (Maybe UTCTime) Source #

The date and time when the SAML provider was created.

sAMLProviderListEntry_validUntil :: Lens' SAMLProviderListEntry (Maybe UTCTime) Source #

The expiration date and time for the SAML provider.

SSHPublicKey

sSHPublicKey_uploadDate :: Lens' SSHPublicKey (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

sSHPublicKey_userName :: Lens' SSHPublicKey Text Source #

The name of the IAM user associated with the SSH public key.

sSHPublicKey_sSHPublicKeyId :: Lens' SSHPublicKey Text Source #

The unique identifier for the SSH public key.

sSHPublicKey_fingerprint :: Lens' SSHPublicKey Text Source #

The MD5 message digest of the SSH public key.

sSHPublicKey_status :: Lens' SSHPublicKey StatusType Source #

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

SSHPublicKeyMetadata

sSHPublicKeyMetadata_userName :: Lens' SSHPublicKeyMetadata Text Source #

The name of the IAM user associated with the SSH public key.

sSHPublicKeyMetadata_sSHPublicKeyId :: Lens' SSHPublicKeyMetadata Text Source #

The unique identifier for the SSH public key.

sSHPublicKeyMetadata_status :: Lens' SSHPublicKeyMetadata StatusType Source #

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

sSHPublicKeyMetadata_uploadDate :: Lens' SSHPublicKeyMetadata UTCTime Source #

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

ServerCertificate

serverCertificate_certificateChain :: Lens' ServerCertificate (Maybe Text) Source #

The contents of the public key certificate chain.

serverCertificate_tags :: Lens' ServerCertificate (Maybe [Tag]) Source #

A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

serverCertificate_serverCertificateMetadata :: Lens' ServerCertificate ServerCertificateMetadata Source #

The meta information of the server certificate, such as its name, path, ID, and ARN.

serverCertificate_certificateBody :: Lens' ServerCertificate Text Source #

The contents of the public key certificate.

ServerCertificateMetadata

serverCertificateMetadata_uploadDate :: Lens' ServerCertificateMetadata (Maybe UTCTime) Source #

The date when the server certificate was uploaded.

serverCertificateMetadata_expiration :: Lens' ServerCertificateMetadata (Maybe UTCTime) Source #

The date on which the certificate is set to expire.

serverCertificateMetadata_path :: Lens' ServerCertificateMetadata Text Source #

The path to the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

serverCertificateMetadata_serverCertificateId :: Lens' ServerCertificateMetadata Text Source #

The stable and unique string identifying the server certificate. For more information about IDs, see IAM identifiers in the IAM User Guide.

serverCertificateMetadata_arn :: Lens' ServerCertificateMetadata Text Source #

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 IAM User Guide.

ServiceLastAccessed

serviceLastAccessed_lastAuthenticated :: Lens' ServiceLastAccessed (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

serviceLastAccessed_trackedActionsLastAccessed :: Lens' ServiceLastAccessed (Maybe [TrackedActionLastAccessed]) Source #

An object that contains details about the most recent attempt to access a tracked action within the service.

This field is null if there no tracked actions or if the principal did not use the tracked actions within the reporting period. This field is also null if the report was generated at the service level and not the action level. For more information, see the Granularity field in GenerateServiceLastAccessedDetails.

serviceLastAccessed_lastAuthenticatedEntity :: Lens' ServiceLastAccessed (Maybe Text) Source #

The ARN of the authenticated entity (user or role) that last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

serviceLastAccessed_lastAuthenticatedRegion :: Lens' ServiceLastAccessed (Maybe Text) Source #

The Region from which the authenticated entity (user or role) last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

serviceLastAccessed_totalAuthenticatedEntities :: Lens' ServiceLastAccessed (Maybe Int) Source #

The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access the service.

This field is null if no principals attempted to access the service within the reporting period.

serviceLastAccessed_serviceName :: Lens' ServiceLastAccessed Text Source #

The name of the service in which access was attempted.

serviceLastAccessed_serviceNamespace :: Lens' ServiceLastAccessed Text Source #

The namespace of the service in which access was attempted.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

ServiceSpecificCredential

serviceSpecificCredential_createDate :: Lens' ServiceSpecificCredential UTCTime Source #

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

serviceSpecificCredential_serviceName :: Lens' ServiceSpecificCredential Text Source #

The name of the service associated with the service-specific credential.

serviceSpecificCredential_serviceUserName :: Lens' ServiceSpecificCredential Text Source #

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

serviceSpecificCredential_servicePassword :: Lens' ServiceSpecificCredential Text Source #

The generated password for the service-specific credential.

serviceSpecificCredential_serviceSpecificCredentialId :: Lens' ServiceSpecificCredential Text Source #

The unique identifier for the service-specific credential.

serviceSpecificCredential_userName :: Lens' ServiceSpecificCredential Text Source #

The name of the IAM user associated with the service-specific credential.

serviceSpecificCredential_status :: Lens' ServiceSpecificCredential StatusType Source #

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

ServiceSpecificCredentialMetadata

serviceSpecificCredentialMetadata_userName :: Lens' ServiceSpecificCredentialMetadata Text Source #

The name of the IAM user associated with the service-specific credential.

serviceSpecificCredentialMetadata_status :: Lens' ServiceSpecificCredentialMetadata StatusType Source #

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

serviceSpecificCredentialMetadata_serviceUserName :: Lens' ServiceSpecificCredentialMetadata Text Source #

The generated user name for the service-specific credential.

serviceSpecificCredentialMetadata_createDate :: Lens' ServiceSpecificCredentialMetadata UTCTime Source #

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

serviceSpecificCredentialMetadata_serviceName :: Lens' ServiceSpecificCredentialMetadata Text Source #

The name of the service associated with the service-specific credential.

SigningCertificate

signingCertificate_uploadDate :: Lens' SigningCertificate (Maybe UTCTime) Source #

The date when the signing certificate was uploaded.

signingCertificate_userName :: Lens' SigningCertificate Text Source #

The name of the user the signing certificate is associated with.

signingCertificate_certificateBody :: Lens' SigningCertificate Text Source #

The contents of the signing certificate.

signingCertificate_status :: Lens' SigningCertificate StatusType Source #

The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

SimulatePolicyResponse

simulatePolicyResponse_marker :: Lens' SimulatePolicyResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

simulatePolicyResponse_isTruncated :: Lens' SimulatePolicyResponse (Maybe Bool) Source #

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. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

Statement

statement_sourcePolicyId :: Lens' Statement (Maybe Text) Source #

The identifier of the policy that was provided as an input.

statement_endPosition :: Lens' Statement (Maybe Position) Source #

The row and column of the end of a Statement in an IAM policy.

statement_startPosition :: Lens' Statement (Maybe Position) Source #

The row and column of the beginning of the Statement in an IAM policy.

Tag

tag_key :: Lens' Tag Text Source #

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

tag_value :: Lens' Tag Text Source #

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

TrackedActionLastAccessed

trackedActionLastAccessed_lastAccessedTime :: Lens' TrackedActionLastAccessed (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the tracked service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

trackedActionLastAccessed_actionName :: Lens' TrackedActionLastAccessed (Maybe Text) Source #

The name of the tracked action to which access was attempted. Tracked actions are actions that report activity to IAM.

trackedActionLastAccessed_lastAccessedRegion :: Lens' TrackedActionLastAccessed (Maybe Text) Source #

The Region from which the authenticated entity (user or role) last attempted to access the tracked action. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

User

user_passwordLastUsed :: Lens' User (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.
  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

user_path :: Lens' User (Maybe Text) Source #

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

The ARN of the policy used to set the permissions boundary for the user.

user_permissionsBoundary :: Lens' User (Maybe AttachedPermissionsBoundary) Source #

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

user_tags :: Lens' User (Maybe [Tag]) Source #

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

user_userName :: Lens' User Text Source #

The friendly name identifying the user.

user_userId :: Lens' User Text Source #

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

user_arn :: Lens' User Text Source #

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 IAM User Guide.

user_createDate :: Lens' User UTCTime Source #

The date and time, in ISO 8601 date-time format, when the user was created.

UserDetail

userDetail_groupList :: Lens' UserDetail (Maybe [Text]) Source #

A list of IAM groups that the user is in.

userDetail_arn :: Lens' UserDetail (Maybe Text) Source #

Undocumented member.

userDetail_path :: Lens' UserDetail (Maybe Text) Source #

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

userDetail_createDate :: Lens' UserDetail (Maybe UTCTime) Source #

The date and time, in ISO 8601 date-time format, when the user was created.

userDetail_userName :: Lens' UserDetail (Maybe Text) Source #

The friendly name identifying the user.

userDetail_userId :: Lens' UserDetail (Maybe Text) Source #

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

userDetail_permissionsBoundary :: Lens' UserDetail (Maybe AttachedPermissionsBoundary) Source #

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

userDetail_userPolicyList :: Lens' UserDetail (Maybe [PolicyDetail]) Source #

A list of the inline policies embedded in the user.

userDetail_tags :: Lens' UserDetail (Maybe [Tag]) Source #

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

userDetail_attachedManagedPolicies :: Lens' UserDetail (Maybe [AttachedPolicy]) Source #

A list of the managed policies attached to the user.

VirtualMFADevice

virtualMFADevice_qRCodePNG :: Lens' VirtualMFADevice (Maybe ByteString) Source #

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

virtualMFADevice_base32StringSeed :: Lens' VirtualMFADevice (Maybe ByteString) Source #

The base32 seed defined as specified in RFC3548. The Base32StringSeed is base64-encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

virtualMFADevice_user :: Lens' VirtualMFADevice (Maybe User) Source #

The IAM user associated with this virtual MFA device.

virtualMFADevice_enableDate :: Lens' VirtualMFADevice (Maybe UTCTime) Source #

The date and time on which the virtual MFA device was enabled.

virtualMFADevice_tags :: Lens' VirtualMFADevice (Maybe [Tag]) Source #

A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

virtualMFADevice_serialNumber :: Lens' VirtualMFADevice Text Source #

The serial number associated with VirtualMFADevice.