IAMClient
Auto-generated documentation for IAM type annotations stubs module types-aiobotocore-iam.
IAMClient
Type annotations and code completion for session.client("iam")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_iam.client import IAMClient
session = Session()
async with session.client("iam") as client:
client: IAMClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("iam").exceptions
structure.
async with session.client("iam") as client:
try:
do_something(client)
except (
client.ClientError,
client.ConcurrentModificationException,
client.CredentialReportExpiredException,
client.CredentialReportNotPresentException,
client.CredentialReportNotReadyException,
client.DeleteConflictException,
client.DuplicateCertificateException,
client.DuplicateSSHPublicKeyException,
client.EntityAlreadyExistsException,
client.EntityTemporarilyUnmodifiableException,
client.InvalidAuthenticationCodeException,
client.InvalidCertificateException,
client.InvalidInputException,
client.InvalidPublicKeyException,
client.InvalidUserTypeException,
client.KeyPairMismatchException,
client.LimitExceededException,
client.MalformedCertificateException,
client.MalformedPolicyDocumentException,
client.NoSuchEntityException,
client.PasswordPolicyViolationException,
client.PolicyEvaluationException,
client.PolicyNotAttachableException,
client.ReportGenerationLimitExceededException,
client.ServiceFailureException,
client.ServiceNotSupportedException,
client.UnmodifiableEntityException,
client.UnrecognizedPublicKeyEncodingException,
) as e:
print(e)
from types_aiobotocore_iam.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
add_client_id_to_open_id_connect_provider
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
Type annotations and code completion for session.client("iam").add_client_id_to_open_id_connect_provider
method.
boto3 documentation
await def add_client_id_to_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
ClientID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AddClientIDToOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
"ClientID": ...,
}
parent.add_client_id_to_open_id_connect_provider(**kwargs)
add_role_to_instance_profile
Adds the specified IAM role to the specified instance profile.
Type annotations and code completion for session.client("iam").add_role_to_instance_profile
method.
boto3 documentation
await def add_role_to_instance_profile(
self,
*,
InstanceProfileName: str,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AddRoleToInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
"RoleName": ...,
}
parent.add_role_to_instance_profile(**kwargs)
add_user_to_group
Adds the specified user to the specified group.
Type annotations and code completion for session.client("iam").add_user_to_group
method.
boto3 documentation
await def add_user_to_group(
self,
*,
GroupName: str,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AddUserToGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserName": ...,
}
parent.add_user_to_group(**kwargs)
attach_group_policy
Attaches the specified managed policy to the specified IAM group.
Type annotations and code completion for session.client("iam").attach_group_policy
method.
boto3 documentation
await def attach_group_policy(
self,
*,
GroupName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AttachGroupPolicyRequestRequestTypeDef = { # (1)
"GroupName": ...,
"PolicyArn": ...,
}
parent.attach_group_policy(**kwargs)
attach_role_policy
Attaches the specified managed policy to the specified IAM role.
Type annotations and code completion for session.client("iam").attach_role_policy
method.
boto3 documentation
await def attach_role_policy(
self,
*,
RoleName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AttachRolePolicyRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyArn": ...,
}
parent.attach_role_policy(**kwargs)
attach_user_policy
Attaches the specified managed policy to the specified user.
Type annotations and code completion for session.client("iam").attach_user_policy
method.
boto3 documentation
await def attach_user_policy(
self,
*,
UserName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AttachUserPolicyRequestRequestTypeDef = { # (1)
"UserName": ...,
"PolicyArn": ...,
}
parent.attach_user_policy(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("iam").can_paginate
method.
boto3 documentation
change_password
Changes the password of the IAM user who is calling this operation.
Type annotations and code completion for session.client("iam").change_password
method.
boto3 documentation
await def change_password(
self,
*,
OldPassword: str,
NewPassword: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ChangePasswordRequestRequestTypeDef = { # (1)
"OldPassword": ...,
"NewPassword": ...,
}
parent.change_password(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("iam").close
method.
boto3 documentation
create_access_key
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user.
Type annotations and code completion for session.client("iam").create_access_key
method.
boto3 documentation
await def create_access_key(
self,
*,
UserName: str = ...,
) -> CreateAccessKeyResponseTypeDef: # (1)
...
kwargs: CreateAccessKeyRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.create_access_key(**kwargs)
create_account_alias
Creates an alias for your Amazon Web Services account.
Type annotations and code completion for session.client("iam").create_account_alias
method.
boto3 documentation
await def create_account_alias(
self,
*,
AccountAlias: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: CreateAccountAliasRequestRequestTypeDef = { # (1)
"AccountAlias": ...,
}
parent.create_account_alias(**kwargs)
create_group
Creates a new group.
Type annotations and code completion for session.client("iam").create_group
method.
boto3 documentation
await def create_group(
self,
*,
GroupName: str,
Path: str = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.create_group(**kwargs)
create_instance_profile
Creates a new instance profile.
Type annotations and code completion for session.client("iam").create_instance_profile
method.
boto3 documentation
await def create_instance_profile(
self,
*,
InstanceProfileName: str,
Path: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateInstanceProfileResponseTypeDef: # (2)
...
kwargs: CreateInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
}
parent.create_instance_profile(**kwargs)
create_login_profile
Creates a password for the specified IAM user.
Type annotations and code completion for session.client("iam").create_login_profile
method.
boto3 documentation
await def create_login_profile(
self,
*,
UserName: str,
Password: str,
PasswordResetRequired: bool = ...,
) -> CreateLoginProfileResponseTypeDef: # (1)
...
kwargs: CreateLoginProfileRequestRequestTypeDef = { # (1)
"UserName": ...,
"Password": ...,
}
parent.create_login_profile(**kwargs)
create_open_id_connect_provider
Creates an IAM entity to describe an identity provider (IdP) that supports
OpenID Connect (OIDC) <http://openid.net/connect/>
__ .
Type annotations and code completion for session.client("iam").create_open_id_connect_provider
method.
boto3 documentation
await def create_open_id_connect_provider(
self,
*,
Url: str,
ThumbprintList: Sequence[str],
ClientIDList: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateOpenIDConnectProviderResponseTypeDef: # (2)
...
kwargs: CreateOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"Url": ...,
"ThumbprintList": ...,
}
parent.create_open_id_connect_provider(**kwargs)
create_policy
Creates a new managed policy for your Amazon Web Services account.
Type annotations and code completion for session.client("iam").create_policy
method.
boto3 documentation
await def create_policy(
self,
*,
PolicyName: str,
PolicyDocument: str,
Path: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePolicyResponseTypeDef: # (2)
...
kwargs: CreatePolicyRequestRequestTypeDef = { # (1)
"PolicyName": ...,
"PolicyDocument": ...,
}
parent.create_policy(**kwargs)
create_policy_version
Creates a new version of the specified managed policy.
Type annotations and code completion for session.client("iam").create_policy_version
method.
boto3 documentation
await def create_policy_version(
self,
*,
PolicyArn: str,
PolicyDocument: str,
SetAsDefault: bool = ...,
) -> CreatePolicyVersionResponseTypeDef: # (1)
...
kwargs: CreatePolicyVersionRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
"PolicyDocument": ...,
}
parent.create_policy_version(**kwargs)
create_role
Creates a new role for your Amazon Web Services account.
Type annotations and code completion for session.client("iam").create_role
method.
boto3 documentation
await def create_role(
self,
*,
RoleName: str,
AssumeRolePolicyDocument: str,
Path: str = ...,
Description: str = ...,
MaxSessionDuration: int = ...,
PermissionsBoundary: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateRoleResponseTypeDef: # (2)
...
- See TagTypeDef
- See CreateRoleResponseTypeDef
kwargs: CreateRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
"AssumeRolePolicyDocument": ...,
}
parent.create_role(**kwargs)
create_saml_provider
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
Type annotations and code completion for session.client("iam").create_saml_provider
method.
boto3 documentation
await def create_saml_provider(
self,
*,
SAMLMetadataDocument: str,
Name: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSAMLProviderResponseTypeDef: # (2)
...
kwargs: CreateSAMLProviderRequestRequestTypeDef = { # (1)
"SAMLMetadataDocument": ...,
"Name": ...,
}
parent.create_saml_provider(**kwargs)
create_service_linked_role
Creates an IAM role that is linked to a specific Amazon Web Services service.
Type annotations and code completion for session.client("iam").create_service_linked_role
method.
boto3 documentation
await def create_service_linked_role(
self,
*,
AWSServiceName: str,
Description: str = ...,
CustomSuffix: str = ...,
) -> CreateServiceLinkedRoleResponseTypeDef: # (1)
...
kwargs: CreateServiceLinkedRoleRequestRequestTypeDef = { # (1)
"AWSServiceName": ...,
}
parent.create_service_linked_role(**kwargs)
create_service_specific_credential
Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request.
Type annotations and code completion for session.client("iam").create_service_specific_credential
method.
boto3 documentation
await def create_service_specific_credential(
self,
*,
UserName: str,
ServiceName: str,
) -> CreateServiceSpecificCredentialResponseTypeDef: # (1)
...
kwargs: CreateServiceSpecificCredentialRequestRequestTypeDef = { # (1)
"UserName": ...,
"ServiceName": ...,
}
parent.create_service_specific_credential(**kwargs)
create_user
Creates a new IAM user for your Amazon Web Services account.
Type annotations and code completion for session.client("iam").create_user
method.
boto3 documentation
await def create_user(
self,
*,
UserName: str,
Path: str = ...,
PermissionsBoundary: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateUserResponseTypeDef: # (2)
...
- See TagTypeDef
- See CreateUserResponseTypeDef
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.create_user(**kwargs)
create_virtual_mfa_device
Creates a new virtual MFA device for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").create_virtual_mfa_device
method.
boto3 documentation
await def create_virtual_mfa_device(
self,
*,
VirtualMFADeviceName: str,
Path: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateVirtualMFADeviceResponseTypeDef: # (2)
...
kwargs: CreateVirtualMFADeviceRequestRequestTypeDef = { # (1)
"VirtualMFADeviceName": ...,
}
parent.create_virtual_mfa_device(**kwargs)
deactivate_mfa_device
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
Type annotations and code completion for session.client("iam").deactivate_mfa_device
method.
boto3 documentation
await def deactivate_mfa_device(
self,
*,
UserName: str,
SerialNumber: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeactivateMFADeviceRequestRequestTypeDef = { # (1)
"UserName": ...,
"SerialNumber": ...,
}
parent.deactivate_mfa_device(**kwargs)
delete_access_key
Deletes the access key pair associated with the specified IAM user.
Type annotations and code completion for session.client("iam").delete_access_key
method.
boto3 documentation
await def delete_access_key(
self,
*,
AccessKeyId: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAccessKeyRequestRequestTypeDef = { # (1)
"AccessKeyId": ...,
}
parent.delete_access_key(**kwargs)
delete_account_alias
Deletes the specified Amazon Web Services account alias.
Type annotations and code completion for session.client("iam").delete_account_alias
method.
boto3 documentation
await def delete_account_alias(
self,
*,
AccountAlias: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAccountAliasRequestRequestTypeDef = { # (1)
"AccountAlias": ...,
}
parent.delete_account_alias(**kwargs)
delete_account_password_policy
Deletes the password policy for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").delete_account_password_policy
method.
boto3 documentation
await def delete_account_password_policy(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...
delete_group
Deletes the specified IAM group.
Type annotations and code completion for session.client("iam").delete_group
method.
boto3 documentation
await def delete_group(
self,
*,
GroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.delete_group(**kwargs)
delete_group_policy
Deletes the specified inline policy that is embedded in the specified IAM group.
Type annotations and code completion for session.client("iam").delete_group_policy
method.
boto3 documentation
await def delete_group_policy(
self,
*,
GroupName: str,
PolicyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteGroupPolicyRequestRequestTypeDef = { # (1)
"GroupName": ...,
"PolicyName": ...,
}
parent.delete_group_policy(**kwargs)
delete_instance_profile
Deletes the specified instance profile.
Type annotations and code completion for session.client("iam").delete_instance_profile
method.
boto3 documentation
await def delete_instance_profile(
self,
*,
InstanceProfileName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
}
parent.delete_instance_profile(**kwargs)
delete_login_profile
Deletes the password for the specified IAM user, which terminates the user's ability to access Amazon Web Services services through the Amazon Web Services Management Console.
Type annotations and code completion for session.client("iam").delete_login_profile
method.
boto3 documentation
await def delete_login_profile(
self,
*,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteLoginProfileRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.delete_login_profile(**kwargs)
delete_open_id_connect_provider
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Type annotations and code completion for session.client("iam").delete_open_id_connect_provider
method.
boto3 documentation
await def delete_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
}
parent.delete_open_id_connect_provider(**kwargs)
delete_policy
Deletes the specified managed policy.
Type annotations and code completion for session.client("iam").delete_policy
method.
boto3 documentation
await def delete_policy(
self,
*,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePolicyRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
}
parent.delete_policy(**kwargs)
delete_policy_version
Deletes the specified version from the specified managed policy.
Type annotations and code completion for session.client("iam").delete_policy_version
method.
boto3 documentation
await def delete_policy_version(
self,
*,
PolicyArn: str,
VersionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePolicyVersionRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
"VersionId": ...,
}
parent.delete_policy_version(**kwargs)
delete_role
Deletes the specified role.
Type annotations and code completion for session.client("iam").delete_role
method.
boto3 documentation
await def delete_role(
self,
*,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.delete_role(**kwargs)
delete_role_permissions_boundary
Deletes the permissions boundary for the specified IAM role.
Type annotations and code completion for session.client("iam").delete_role_permissions_boundary
method.
boto3 documentation
await def delete_role_permissions_boundary(
self,
*,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRolePermissionsBoundaryRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.delete_role_permissions_boundary(**kwargs)
delete_role_policy
Deletes the specified inline policy that is embedded in the specified IAM role.
Type annotations and code completion for session.client("iam").delete_role_policy
method.
boto3 documentation
await def delete_role_policy(
self,
*,
RoleName: str,
PolicyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRolePolicyRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyName": ...,
}
parent.delete_role_policy(**kwargs)
delete_saml_provider
Deletes a SAML provider resource in IAM.
Type annotations and code completion for session.client("iam").delete_saml_provider
method.
boto3 documentation
await def delete_saml_provider(
self,
*,
SAMLProviderArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSAMLProviderRequestRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
}
parent.delete_saml_provider(**kwargs)
delete_server_certificate
Deletes the specified server certificate.
Type annotations and code completion for session.client("iam").delete_server_certificate
method.
boto3 documentation
await def delete_server_certificate(
self,
*,
ServerCertificateName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteServerCertificateRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
}
parent.delete_server_certificate(**kwargs)
delete_service_linked_role
Submits a service-linked role deletion request and returns a DeletionTaskId
,
which you can use to check the status of the deletion.
Type annotations and code completion for session.client("iam").delete_service_linked_role
method.
boto3 documentation
await def delete_service_linked_role(
self,
*,
RoleName: str,
) -> DeleteServiceLinkedRoleResponseTypeDef: # (1)
...
kwargs: DeleteServiceLinkedRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.delete_service_linked_role(**kwargs)
delete_service_specific_credential
Deletes the specified service-specific credential.
Type annotations and code completion for session.client("iam").delete_service_specific_credential
method.
boto3 documentation
await def delete_service_specific_credential(
self,
*,
ServiceSpecificCredentialId: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteServiceSpecificCredentialRequestRequestTypeDef = { # (1)
"ServiceSpecificCredentialId": ...,
}
parent.delete_service_specific_credential(**kwargs)
delete_signing_certificate
Deletes a signing certificate associated with the specified IAM user.
Type annotations and code completion for session.client("iam").delete_signing_certificate
method.
boto3 documentation
await def delete_signing_certificate(
self,
*,
CertificateId: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSigningCertificateRequestRequestTypeDef = { # (1)
"CertificateId": ...,
}
parent.delete_signing_certificate(**kwargs)
delete_ssh_public_key
Deletes the specified SSH public key.
Type annotations and code completion for session.client("iam").delete_ssh_public_key
method.
boto3 documentation
await def delete_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSSHPublicKeyRequestRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyId": ...,
}
parent.delete_ssh_public_key(**kwargs)
delete_user
Deletes the specified IAM user.
Type annotations and code completion for session.client("iam").delete_user
method.
boto3 documentation
await def delete_user(
self,
*,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.delete_user(**kwargs)
delete_user_permissions_boundary
Deletes the permissions boundary for the specified IAM user.
Type annotations and code completion for session.client("iam").delete_user_permissions_boundary
method.
boto3 documentation
await def delete_user_permissions_boundary(
self,
*,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserPermissionsBoundaryRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.delete_user_permissions_boundary(**kwargs)
delete_user_policy
Deletes the specified inline policy that is embedded in the specified IAM user.
Type annotations and code completion for session.client("iam").delete_user_policy
method.
boto3 documentation
await def delete_user_policy(
self,
*,
UserName: str,
PolicyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserPolicyRequestRequestTypeDef = { # (1)
"UserName": ...,
"PolicyName": ...,
}
parent.delete_user_policy(**kwargs)
delete_virtual_mfa_device
Deletes a virtual MFA device.
Type annotations and code completion for session.client("iam").delete_virtual_mfa_device
method.
boto3 documentation
await def delete_virtual_mfa_device(
self,
*,
SerialNumber: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteVirtualMFADeviceRequestRequestTypeDef = { # (1)
"SerialNumber": ...,
}
parent.delete_virtual_mfa_device(**kwargs)
detach_group_policy
Removes the specified managed policy from the specified IAM group.
Type annotations and code completion for session.client("iam").detach_group_policy
method.
boto3 documentation
await def detach_group_policy(
self,
*,
GroupName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DetachGroupPolicyRequestRequestTypeDef = { # (1)
"GroupName": ...,
"PolicyArn": ...,
}
parent.detach_group_policy(**kwargs)
detach_role_policy
Removes the specified managed policy from the specified role.
Type annotations and code completion for session.client("iam").detach_role_policy
method.
boto3 documentation
await def detach_role_policy(
self,
*,
RoleName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DetachRolePolicyRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyArn": ...,
}
parent.detach_role_policy(**kwargs)
detach_user_policy
Removes the specified managed policy from the specified user.
Type annotations and code completion for session.client("iam").detach_user_policy
method.
boto3 documentation
await def detach_user_policy(
self,
*,
UserName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DetachUserPolicyRequestRequestTypeDef = { # (1)
"UserName": ...,
"PolicyArn": ...,
}
parent.detach_user_policy(**kwargs)
enable_mfa_device
Enables the specified MFA device and associates it with the specified IAM user.
Type annotations and code completion for session.client("iam").enable_mfa_device
method.
boto3 documentation
await def enable_mfa_device(
self,
*,
UserName: str,
SerialNumber: str,
AuthenticationCode1: str,
AuthenticationCode2: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: EnableMFADeviceRequestRequestTypeDef = { # (1)
"UserName": ...,
"SerialNumber": ...,
"AuthenticationCode1": ...,
"AuthenticationCode2": ...,
}
parent.enable_mfa_device(**kwargs)
generate_credential_report
Generates a credential report for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").generate_credential_report
method.
boto3 documentation
await def generate_credential_report(
self,
) -> GenerateCredentialReportResponseTypeDef: # (1)
...
generate_organizations_access_report
Generates a report for service last accessed data for Organizations.
Type annotations and code completion for session.client("iam").generate_organizations_access_report
method.
boto3 documentation
await def generate_organizations_access_report(
self,
*,
EntityPath: str,
OrganizationsPolicyId: str = ...,
) -> GenerateOrganizationsAccessReportResponseTypeDef: # (1)
...
kwargs: GenerateOrganizationsAccessReportRequestRequestTypeDef = { # (1)
"EntityPath": ...,
}
parent.generate_organizations_access_report(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("iam").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
generate_service_last_accessed_details
Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services.
Type annotations and code completion for session.client("iam").generate_service_last_accessed_details
method.
boto3 documentation
await def generate_service_last_accessed_details(
self,
*,
Arn: str,
Granularity: AccessAdvisorUsageGranularityTypeType = ..., # (1)
) -> GenerateServiceLastAccessedDetailsResponseTypeDef: # (2)
...
kwargs: GenerateServiceLastAccessedDetailsRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.generate_service_last_accessed_details(**kwargs)
get_access_key_last_used
Retrieves information about when the specified access key was last used.
Type annotations and code completion for session.client("iam").get_access_key_last_used
method.
boto3 documentation
await def get_access_key_last_used(
self,
*,
AccessKeyId: str,
) -> GetAccessKeyLastUsedResponseTypeDef: # (1)
...
kwargs: GetAccessKeyLastUsedRequestRequestTypeDef = { # (1)
"AccessKeyId": ...,
}
parent.get_access_key_last_used(**kwargs)
get_account_authorization_details
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another.
Type annotations and code completion for session.client("iam").get_account_authorization_details
method.
boto3 documentation
await def get_account_authorization_details(
self,
*,
Filter: Sequence[EntityTypeType] = ..., # (1)
MaxItems: int = ...,
Marker: str = ...,
) -> GetAccountAuthorizationDetailsResponseTypeDef: # (2)
...
kwargs: GetAccountAuthorizationDetailsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.get_account_authorization_details(**kwargs)
get_account_password_policy
Retrieves the password policy for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").get_account_password_policy
method.
boto3 documentation
await def get_account_password_policy(
self,
) -> GetAccountPasswordPolicyResponseTypeDef: # (1)
...
get_account_summary
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
Type annotations and code completion for session.client("iam").get_account_summary
method.
boto3 documentation
await def get_account_summary(
self,
) -> GetAccountSummaryResponseTypeDef: # (1)
...
get_context_keys_for_custom_policy
Gets a list of all of the context keys referenced in the input policies.
Type annotations and code completion for session.client("iam").get_context_keys_for_custom_policy
method.
boto3 documentation
await def get_context_keys_for_custom_policy(
self,
*,
PolicyInputList: Sequence[str],
) -> GetContextKeysForPolicyResponseTypeDef: # (1)
...
kwargs: GetContextKeysForCustomPolicyRequestRequestTypeDef = { # (1)
"PolicyInputList": ...,
}
parent.get_context_keys_for_custom_policy(**kwargs)
get_context_keys_for_principal_policy
Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity.
Type annotations and code completion for session.client("iam").get_context_keys_for_principal_policy
method.
boto3 documentation
await def get_context_keys_for_principal_policy(
self,
*,
PolicySourceArn: str,
PolicyInputList: Sequence[str] = ...,
) -> GetContextKeysForPolicyResponseTypeDef: # (1)
...
kwargs: GetContextKeysForPrincipalPolicyRequestRequestTypeDef = { # (1)
"PolicySourceArn": ...,
}
parent.get_context_keys_for_principal_policy(**kwargs)
get_credential_report
Retrieves a credential report for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").get_credential_report
method.
boto3 documentation
await def get_credential_report(
self,
) -> GetCredentialReportResponseTypeDef: # (1)
...
get_group
Returns a list of IAM users that are in the specified IAM group.
Type annotations and code completion for session.client("iam").get_group
method.
boto3 documentation
await def get_group(
self,
*,
GroupName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> GetGroupResponseTypeDef: # (1)
...
kwargs: GetGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.get_group(**kwargs)
get_group_policy
Retrieves the specified inline policy document that is embedded in the specified IAM group.
Type annotations and code completion for session.client("iam").get_group_policy
method.
boto3 documentation
await def get_group_policy(
self,
*,
GroupName: str,
PolicyName: str,
) -> GetGroupPolicyResponseTypeDef: # (1)
...
kwargs: GetGroupPolicyRequestRequestTypeDef = { # (1)
"GroupName": ...,
"PolicyName": ...,
}
parent.get_group_policy(**kwargs)
get_instance_profile
Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role.
Type annotations and code completion for session.client("iam").get_instance_profile
method.
boto3 documentation
await def get_instance_profile(
self,
*,
InstanceProfileName: str,
) -> GetInstanceProfileResponseTypeDef: # (1)
...
kwargs: GetInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
}
parent.get_instance_profile(**kwargs)
get_login_profile
Retrieves the user name for the specified IAM user.
Type annotations and code completion for session.client("iam").get_login_profile
method.
boto3 documentation
await def get_login_profile(
self,
*,
UserName: str,
) -> GetLoginProfileResponseTypeDef: # (1)
...
kwargs: GetLoginProfileRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.get_login_profile(**kwargs)
get_open_id_connect_provider
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
Type annotations and code completion for session.client("iam").get_open_id_connect_provider
method.
boto3 documentation
await def get_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
) -> GetOpenIDConnectProviderResponseTypeDef: # (1)
...
kwargs: GetOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
}
parent.get_open_id_connect_provider(**kwargs)
get_organizations_access_report
Retrieves the service last accessed data report for Organizations that was
previously generated using the GenerateOrganizationsAccessReport
operation.
Type annotations and code completion for session.client("iam").get_organizations_access_report
method.
boto3 documentation
await def get_organizations_access_report(
self,
*,
JobId: str,
MaxItems: int = ...,
Marker: str = ...,
SortKey: sortKeyTypeType = ..., # (1)
) -> GetOrganizationsAccessReportResponseTypeDef: # (2)
...
kwargs: GetOrganizationsAccessReportRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_organizations_access_report(**kwargs)
get_policy
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached.
Type annotations and code completion for session.client("iam").get_policy
method.
boto3 documentation
await def get_policy(
self,
*,
PolicyArn: str,
) -> GetPolicyResponseTypeDef: # (1)
...
kwargs: GetPolicyRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
}
parent.get_policy(**kwargs)
get_policy_version
Retrieves information about the specified version of the specified managed policy, including the policy document.
Type annotations and code completion for session.client("iam").get_policy_version
method.
boto3 documentation
await def get_policy_version(
self,
*,
PolicyArn: str,
VersionId: str,
) -> GetPolicyVersionResponseTypeDef: # (1)
...
kwargs: GetPolicyVersionRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
"VersionId": ...,
}
parent.get_policy_version(**kwargs)
get_role
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role.
Type annotations and code completion for session.client("iam").get_role
method.
boto3 documentation
kwargs: GetRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.get_role(**kwargs)
get_role_policy
Retrieves the specified inline policy document that is embedded with the specified IAM role.
Type annotations and code completion for session.client("iam").get_role_policy
method.
boto3 documentation
await def get_role_policy(
self,
*,
RoleName: str,
PolicyName: str,
) -> GetRolePolicyResponseTypeDef: # (1)
...
kwargs: GetRolePolicyRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyName": ...,
}
parent.get_role_policy(**kwargs)
get_saml_provider
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
Type annotations and code completion for session.client("iam").get_saml_provider
method.
boto3 documentation
await def get_saml_provider(
self,
*,
SAMLProviderArn: str,
) -> GetSAMLProviderResponseTypeDef: # (1)
...
kwargs: GetSAMLProviderRequestRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
}
parent.get_saml_provider(**kwargs)
get_server_certificate
Retrieves information about the specified server certificate stored in IAM.
Type annotations and code completion for session.client("iam").get_server_certificate
method.
boto3 documentation
await def get_server_certificate(
self,
*,
ServerCertificateName: str,
) -> GetServerCertificateResponseTypeDef: # (1)
...
kwargs: GetServerCertificateRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
}
parent.get_server_certificate(**kwargs)
get_service_last_accessed_details
Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails
operation.
Type annotations and code completion for session.client("iam").get_service_last_accessed_details
method.
boto3 documentation
await def get_service_last_accessed_details(
self,
*,
JobId: str,
MaxItems: int = ...,
Marker: str = ...,
) -> GetServiceLastAccessedDetailsResponseTypeDef: # (1)
...
kwargs: GetServiceLastAccessedDetailsRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_service_last_accessed_details(**kwargs)
get_service_last_accessed_details_with_entities
After you generate a group or policy report using the
GenerateServiceLastAccessedDetails
operation, you can use the JobId
parameter in GetServiceLastAccessedDetailsWithEntities
.
Type annotations and code completion for session.client("iam").get_service_last_accessed_details_with_entities
method.
boto3 documentation
await def get_service_last_accessed_details_with_entities(
self,
*,
JobId: str,
ServiceNamespace: str,
MaxItems: int = ...,
Marker: str = ...,
) -> GetServiceLastAccessedDetailsWithEntitiesResponseTypeDef: # (1)
...
kwargs: GetServiceLastAccessedDetailsWithEntitiesRequestRequestTypeDef = { # (1)
"JobId": ...,
"ServiceNamespace": ...,
}
parent.get_service_last_accessed_details_with_entities(**kwargs)
get_service_linked_role_deletion_status
Retrieves the status of your service-linked role deletion.
Type annotations and code completion for session.client("iam").get_service_linked_role_deletion_status
method.
boto3 documentation
await def get_service_linked_role_deletion_status(
self,
*,
DeletionTaskId: str,
) -> GetServiceLinkedRoleDeletionStatusResponseTypeDef: # (1)
...
kwargs: GetServiceLinkedRoleDeletionStatusRequestRequestTypeDef = { # (1)
"DeletionTaskId": ...,
}
parent.get_service_linked_role_deletion_status(**kwargs)
get_ssh_public_key
Retrieves the specified SSH public key, including metadata about the key.
Type annotations and code completion for session.client("iam").get_ssh_public_key
method.
boto3 documentation
await def get_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyId: str,
Encoding: encodingTypeType, # (1)
) -> GetSSHPublicKeyResponseTypeDef: # (2)
...
kwargs: GetSSHPublicKeyRequestRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyId": ...,
"Encoding": ...,
}
parent.get_ssh_public_key(**kwargs)
get_user
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
Type annotations and code completion for session.client("iam").get_user
method.
boto3 documentation
await def get_user(
self,
*,
UserName: str = ...,
) -> GetUserResponseTypeDef: # (1)
...
kwargs: GetUserRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.get_user(**kwargs)
get_user_policy
Retrieves the specified inline policy document that is embedded in the specified IAM user.
Type annotations and code completion for session.client("iam").get_user_policy
method.
boto3 documentation
await def get_user_policy(
self,
*,
UserName: str,
PolicyName: str,
) -> GetUserPolicyResponseTypeDef: # (1)
...
kwargs: GetUserPolicyRequestRequestTypeDef = { # (1)
"UserName": ...,
"PolicyName": ...,
}
parent.get_user_policy(**kwargs)
list_access_keys
Returns information about the access key IDs associated with the specified IAM user.
Type annotations and code completion for session.client("iam").list_access_keys
method.
boto3 documentation
await def list_access_keys(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAccessKeysResponseTypeDef: # (1)
...
kwargs: ListAccessKeysRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_access_keys(**kwargs)
list_account_aliases
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).
Type annotations and code completion for session.client("iam").list_account_aliases
method.
boto3 documentation
await def list_account_aliases(
self,
*,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAccountAliasesResponseTypeDef: # (1)
...
kwargs: ListAccountAliasesRequestRequestTypeDef = { # (1)
"Marker": ...,
}
parent.list_account_aliases(**kwargs)
list_attached_group_policies
Lists all managed policies that are attached to the specified IAM group.
Type annotations and code completion for session.client("iam").list_attached_group_policies
method.
boto3 documentation
await def list_attached_group_policies(
self,
*,
GroupName: str,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAttachedGroupPoliciesResponseTypeDef: # (1)
...
kwargs: ListAttachedGroupPoliciesRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.list_attached_group_policies(**kwargs)
list_attached_role_policies
Lists all managed policies that are attached to the specified IAM role.
Type annotations and code completion for session.client("iam").list_attached_role_policies
method.
boto3 documentation
await def list_attached_role_policies(
self,
*,
RoleName: str,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAttachedRolePoliciesResponseTypeDef: # (1)
...
kwargs: ListAttachedRolePoliciesRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.list_attached_role_policies(**kwargs)
list_attached_user_policies
Lists all managed policies that are attached to the specified IAM user.
Type annotations and code completion for session.client("iam").list_attached_user_policies
method.
boto3 documentation
await def list_attached_user_policies(
self,
*,
UserName: str,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAttachedUserPoliciesResponseTypeDef: # (1)
...
kwargs: ListAttachedUserPoliciesRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_attached_user_policies(**kwargs)
list_entities_for_policy
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
Type annotations and code completion for session.client("iam").list_entities_for_policy
method.
boto3 documentation
await def list_entities_for_policy(
self,
*,
PolicyArn: str,
EntityFilter: EntityTypeType = ..., # (1)
PathPrefix: str = ...,
PolicyUsageFilter: PolicyUsageTypeType = ..., # (2)
Marker: str = ...,
MaxItems: int = ...,
) -> ListEntitiesForPolicyResponseTypeDef: # (3)
...
kwargs: ListEntitiesForPolicyRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
}
parent.list_entities_for_policy(**kwargs)
list_group_policies
Lists the names of the inline policies that are embedded in the specified IAM group.
Type annotations and code completion for session.client("iam").list_group_policies
method.
boto3 documentation
await def list_group_policies(
self,
*,
GroupName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListGroupPoliciesResponseTypeDef: # (1)
...
kwargs: ListGroupPoliciesRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.list_group_policies(**kwargs)
list_groups
Lists the IAM groups that have the specified path prefix.
Type annotations and code completion for session.client("iam").list_groups
method.
boto3 documentation
await def list_groups(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListGroupsResponseTypeDef: # (1)
...
kwargs: ListGroupsRequestRequestTypeDef = { # (1)
"PathPrefix": ...,
}
parent.list_groups(**kwargs)
list_groups_for_user
Lists the IAM groups that the specified IAM user belongs to.
Type annotations and code completion for session.client("iam").list_groups_for_user
method.
boto3 documentation
await def list_groups_for_user(
self,
*,
UserName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListGroupsForUserResponseTypeDef: # (1)
...
kwargs: ListGroupsForUserRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_groups_for_user(**kwargs)
list_instance_profile_tags
Lists the tags that are attached to the specified IAM instance profile.
Type annotations and code completion for session.client("iam").list_instance_profile_tags
method.
boto3 documentation
await def list_instance_profile_tags(
self,
*,
InstanceProfileName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListInstanceProfileTagsResponseTypeDef: # (1)
...
kwargs: ListInstanceProfileTagsRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
}
parent.list_instance_profile_tags(**kwargs)
list_instance_profiles
Lists the instance profiles that have the specified path prefix.
Type annotations and code completion for session.client("iam").list_instance_profiles
method.
boto3 documentation
await def list_instance_profiles(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListInstanceProfilesResponseTypeDef: # (1)
...
kwargs: ListInstanceProfilesRequestRequestTypeDef = { # (1)
"PathPrefix": ...,
}
parent.list_instance_profiles(**kwargs)
list_instance_profiles_for_role
Lists the instance profiles that have the specified associated IAM role.
Type annotations and code completion for session.client("iam").list_instance_profiles_for_role
method.
boto3 documentation
await def list_instance_profiles_for_role(
self,
*,
RoleName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListInstanceProfilesForRoleResponseTypeDef: # (1)
...
kwargs: ListInstanceProfilesForRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.list_instance_profiles_for_role(**kwargs)
list_mfa_device_tags
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.
Type annotations and code completion for session.client("iam").list_mfa_device_tags
method.
boto3 documentation
await def list_mfa_device_tags(
self,
*,
SerialNumber: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListMFADeviceTagsResponseTypeDef: # (1)
...
kwargs: ListMFADeviceTagsRequestRequestTypeDef = { # (1)
"SerialNumber": ...,
}
parent.list_mfa_device_tags(**kwargs)
list_mfa_devices
Lists the MFA devices for an IAM user.
Type annotations and code completion for session.client("iam").list_mfa_devices
method.
boto3 documentation
await def list_mfa_devices(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListMFADevicesResponseTypeDef: # (1)
...
kwargs: ListMFADevicesRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_mfa_devices(**kwargs)
list_open_id_connect_provider_tags
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.
Type annotations and code completion for session.client("iam").list_open_id_connect_provider_tags
method.
boto3 documentation
await def list_open_id_connect_provider_tags(
self,
*,
OpenIDConnectProviderArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListOpenIDConnectProviderTagsResponseTypeDef: # (1)
...
kwargs: ListOpenIDConnectProviderTagsRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
}
parent.list_open_id_connect_provider_tags(**kwargs)
list_open_id_connect_providers
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.
Type annotations and code completion for session.client("iam").list_open_id_connect_providers
method.
boto3 documentation
await def list_open_id_connect_providers(
self,
) -> ListOpenIDConnectProvidersResponseTypeDef: # (1)
...
list_policies
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.
Type annotations and code completion for session.client("iam").list_policies
method.
boto3 documentation
await def list_policies(
self,
*,
Scope: policyScopeTypeType = ..., # (1)
OnlyAttached: bool = ...,
PathPrefix: str = ...,
PolicyUsageFilter: PolicyUsageTypeType = ..., # (2)
Marker: str = ...,
MaxItems: int = ...,
) -> ListPoliciesResponseTypeDef: # (3)
...
kwargs: ListPoliciesRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_policies(**kwargs)
list_policies_granting_service_access
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
Type annotations and code completion for session.client("iam").list_policies_granting_service_access
method.
boto3 documentation
await def list_policies_granting_service_access(
self,
*,
Arn: str,
ServiceNamespaces: Sequence[str],
Marker: str = ...,
) -> ListPoliciesGrantingServiceAccessResponseTypeDef: # (1)
...
kwargs: ListPoliciesGrantingServiceAccessRequestRequestTypeDef = { # (1)
"Arn": ...,
"ServiceNamespaces": ...,
}
parent.list_policies_granting_service_access(**kwargs)
list_policy_tags
Lists the tags that are attached to the specified IAM customer managed policy.
Type annotations and code completion for session.client("iam").list_policy_tags
method.
boto3 documentation
await def list_policy_tags(
self,
*,
PolicyArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListPolicyTagsResponseTypeDef: # (1)
...
kwargs: ListPolicyTagsRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
}
parent.list_policy_tags(**kwargs)
list_policy_versions
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
Type annotations and code completion for session.client("iam").list_policy_versions
method.
boto3 documentation
await def list_policy_versions(
self,
*,
PolicyArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListPolicyVersionsResponseTypeDef: # (1)
...
kwargs: ListPolicyVersionsRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
}
parent.list_policy_versions(**kwargs)
list_role_policies
Lists the names of the inline policies that are embedded in the specified IAM role.
Type annotations and code completion for session.client("iam").list_role_policies
method.
boto3 documentation
await def list_role_policies(
self,
*,
RoleName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListRolePoliciesResponseTypeDef: # (1)
...
kwargs: ListRolePoliciesRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.list_role_policies(**kwargs)
list_role_tags
Lists the tags that are attached to the specified role.
Type annotations and code completion for session.client("iam").list_role_tags
method.
boto3 documentation
await def list_role_tags(
self,
*,
RoleName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListRoleTagsResponseTypeDef: # (1)
...
kwargs: ListRoleTagsRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.list_role_tags(**kwargs)
list_roles
Lists the IAM roles that have the specified path prefix.
Type annotations and code completion for session.client("iam").list_roles
method.
boto3 documentation
await def list_roles(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListRolesResponseTypeDef: # (1)
...
kwargs: ListRolesRequestRequestTypeDef = { # (1)
"PathPrefix": ...,
}
parent.list_roles(**kwargs)
list_saml_provider_tags
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.
Type annotations and code completion for session.client("iam").list_saml_provider_tags
method.
boto3 documentation
await def list_saml_provider_tags(
self,
*,
SAMLProviderArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListSAMLProviderTagsResponseTypeDef: # (1)
...
kwargs: ListSAMLProviderTagsRequestRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
}
parent.list_saml_provider_tags(**kwargs)
list_saml_providers
Lists the SAML provider resource objects defined in IAM in the account.
Type annotations and code completion for session.client("iam").list_saml_providers
method.
boto3 documentation
await def list_saml_providers(
self,
) -> ListSAMLProvidersResponseTypeDef: # (1)
...
list_server_certificate_tags
Lists the tags that are attached to the specified IAM server certificate.
Type annotations and code completion for session.client("iam").list_server_certificate_tags
method.
boto3 documentation
await def list_server_certificate_tags(
self,
*,
ServerCertificateName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListServerCertificateTagsResponseTypeDef: # (1)
...
kwargs: ListServerCertificateTagsRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
}
parent.list_server_certificate_tags(**kwargs)
list_server_certificates
Lists the server certificates stored in IAM that have the specified path prefix.
Type annotations and code completion for session.client("iam").list_server_certificates
method.
boto3 documentation
await def list_server_certificates(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListServerCertificatesResponseTypeDef: # (1)
...
kwargs: ListServerCertificatesRequestRequestTypeDef = { # (1)
"PathPrefix": ...,
}
parent.list_server_certificates(**kwargs)
list_service_specific_credentials
Returns information about the service-specific credentials associated with the specified IAM user.
Type annotations and code completion for session.client("iam").list_service_specific_credentials
method.
boto3 documentation
await def list_service_specific_credentials(
self,
*,
UserName: str = ...,
ServiceName: str = ...,
) -> ListServiceSpecificCredentialsResponseTypeDef: # (1)
...
kwargs: ListServiceSpecificCredentialsRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_service_specific_credentials(**kwargs)
list_signing_certificates
Returns information about the signing certificates associated with the specified IAM user.
Type annotations and code completion for session.client("iam").list_signing_certificates
method.
boto3 documentation
await def list_signing_certificates(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListSigningCertificatesResponseTypeDef: # (1)
...
kwargs: ListSigningCertificatesRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_signing_certificates(**kwargs)
list_ssh_public_keys
Returns information about the SSH public keys associated with the specified IAM user.
Type annotations and code completion for session.client("iam").list_ssh_public_keys
method.
boto3 documentation
await def list_ssh_public_keys(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListSSHPublicKeysResponseTypeDef: # (1)
...
kwargs: ListSSHPublicKeysRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_ssh_public_keys(**kwargs)
list_user_policies
Lists the names of the inline policies embedded in the specified IAM user.
Type annotations and code completion for session.client("iam").list_user_policies
method.
boto3 documentation
await def list_user_policies(
self,
*,
UserName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListUserPoliciesResponseTypeDef: # (1)
...
kwargs: ListUserPoliciesRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_user_policies(**kwargs)
list_user_tags
Lists the tags that are attached to the specified IAM user.
Type annotations and code completion for session.client("iam").list_user_tags
method.
boto3 documentation
await def list_user_tags(
self,
*,
UserName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListUserTagsResponseTypeDef: # (1)
...
kwargs: ListUserTagsRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_user_tags(**kwargs)
list_users
Lists the IAM users that have the specified path prefix.
Type annotations and code completion for session.client("iam").list_users
method.
boto3 documentation
await def list_users(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListUsersResponseTypeDef: # (1)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"PathPrefix": ...,
}
parent.list_users(**kwargs)
list_virtual_mfa_devices
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
Type annotations and code completion for session.client("iam").list_virtual_mfa_devices
method.
boto3 documentation
await def list_virtual_mfa_devices(
self,
*,
AssignmentStatus: assignmentStatusTypeType = ..., # (1)
Marker: str = ...,
MaxItems: int = ...,
) -> ListVirtualMFADevicesResponseTypeDef: # (2)
...
kwargs: ListVirtualMFADevicesRequestRequestTypeDef = { # (1)
"AssignmentStatus": ...,
}
parent.list_virtual_mfa_devices(**kwargs)
put_group_policy
Adds or updates an inline policy document that is embedded in the specified IAM group.
Type annotations and code completion for session.client("iam").put_group_policy
method.
boto3 documentation
await def put_group_policy(
self,
*,
GroupName: str,
PolicyName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutGroupPolicyRequestRequestTypeDef = { # (1)
"GroupName": ...,
"PolicyName": ...,
"PolicyDocument": ...,
}
parent.put_group_policy(**kwargs)
put_role_permissions_boundary
Adds or updates the policy that is specified as the IAM role's permissions boundary.
Type annotations and code completion for session.client("iam").put_role_permissions_boundary
method.
boto3 documentation
await def put_role_permissions_boundary(
self,
*,
RoleName: str,
PermissionsBoundary: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutRolePermissionsBoundaryRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PermissionsBoundary": ...,
}
parent.put_role_permissions_boundary(**kwargs)
put_role_policy
Adds or updates an inline policy document that is embedded in the specified IAM role.
Type annotations and code completion for session.client("iam").put_role_policy
method.
boto3 documentation
await def put_role_policy(
self,
*,
RoleName: str,
PolicyName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutRolePolicyRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyName": ...,
"PolicyDocument": ...,
}
parent.put_role_policy(**kwargs)
put_user_permissions_boundary
Adds or updates the policy that is specified as the IAM user's permissions boundary.
Type annotations and code completion for session.client("iam").put_user_permissions_boundary
method.
boto3 documentation
await def put_user_permissions_boundary(
self,
*,
UserName: str,
PermissionsBoundary: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutUserPermissionsBoundaryRequestRequestTypeDef = { # (1)
"UserName": ...,
"PermissionsBoundary": ...,
}
parent.put_user_permissions_boundary(**kwargs)
put_user_policy
Adds or updates an inline policy document that is embedded in the specified IAM user.
Type annotations and code completion for session.client("iam").put_user_policy
method.
boto3 documentation
await def put_user_policy(
self,
*,
UserName: str,
PolicyName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutUserPolicyRequestRequestTypeDef = { # (1)
"UserName": ...,
"PolicyName": ...,
"PolicyDocument": ...,
}
parent.put_user_policy(**kwargs)
remove_client_id_from_open_id_connect_provider
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
Type annotations and code completion for session.client("iam").remove_client_id_from_open_id_connect_provider
method.
boto3 documentation
await def remove_client_id_from_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
ClientID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RemoveClientIDFromOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
"ClientID": ...,
}
parent.remove_client_id_from_open_id_connect_provider(**kwargs)
remove_role_from_instance_profile
Removes the specified IAM role from the specified EC2 instance profile.
Type annotations and code completion for session.client("iam").remove_role_from_instance_profile
method.
boto3 documentation
await def remove_role_from_instance_profile(
self,
*,
InstanceProfileName: str,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RemoveRoleFromInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
"RoleName": ...,
}
parent.remove_role_from_instance_profile(**kwargs)
remove_user_from_group
Removes the specified user from the specified group.
Type annotations and code completion for session.client("iam").remove_user_from_group
method.
boto3 documentation
await def remove_user_from_group(
self,
*,
GroupName: str,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RemoveUserFromGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"UserName": ...,
}
parent.remove_user_from_group(**kwargs)
reset_service_specific_credential
Resets the password for a service-specific credential.
Type annotations and code completion for session.client("iam").reset_service_specific_credential
method.
boto3 documentation
await def reset_service_specific_credential(
self,
*,
ServiceSpecificCredentialId: str,
UserName: str = ...,
) -> ResetServiceSpecificCredentialResponseTypeDef: # (1)
...
kwargs: ResetServiceSpecificCredentialRequestRequestTypeDef = { # (1)
"ServiceSpecificCredentialId": ...,
}
parent.reset_service_specific_credential(**kwargs)
resync_mfa_device
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
Type annotations and code completion for session.client("iam").resync_mfa_device
method.
boto3 documentation
await def resync_mfa_device(
self,
*,
UserName: str,
SerialNumber: str,
AuthenticationCode1: str,
AuthenticationCode2: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ResyncMFADeviceRequestRequestTypeDef = { # (1)
"UserName": ...,
"SerialNumber": ...,
"AuthenticationCode1": ...,
"AuthenticationCode2": ...,
}
parent.resync_mfa_device(**kwargs)
set_default_policy_version
Sets the specified version of the specified policy as the policy's default (operative) version.
Type annotations and code completion for session.client("iam").set_default_policy_version
method.
boto3 documentation
await def set_default_policy_version(
self,
*,
PolicyArn: str,
VersionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: SetDefaultPolicyVersionRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
"VersionId": ...,
}
parent.set_default_policy_version(**kwargs)
set_security_token_service_preferences
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").set_security_token_service_preferences
method.
boto3 documentation
await def set_security_token_service_preferences(
self,
*,
GlobalEndpointTokenVersion: globalEndpointTokenVersionType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: SetSecurityTokenServicePreferencesRequestRequestTypeDef = { # (1)
"GlobalEndpointTokenVersion": ...,
}
parent.set_security_token_service_preferences(**kwargs)
simulate_custom_policy
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions.
Type annotations and code completion for session.client("iam").simulate_custom_policy
method.
boto3 documentation
await def simulate_custom_policy(
self,
*,
PolicyInputList: Sequence[str],
ActionNames: Sequence[str],
PermissionsBoundaryPolicyInputList: Sequence[str] = ...,
ResourceArns: Sequence[str] = ...,
ResourcePolicy: str = ...,
ResourceOwner: str = ...,
CallerArn: str = ...,
ContextEntries: Sequence[ContextEntryTypeDef] = ..., # (1)
ResourceHandlingOption: str = ...,
MaxItems: int = ...,
Marker: str = ...,
) -> SimulatePolicyResponseTypeDef: # (2)
...
kwargs: SimulateCustomPolicyRequestRequestTypeDef = { # (1)
"PolicyInputList": ...,
"ActionNames": ...,
}
parent.simulate_custom_policy(**kwargs)
simulate_principal_policy
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions.
Type annotations and code completion for session.client("iam").simulate_principal_policy
method.
boto3 documentation
await def simulate_principal_policy(
self,
*,
PolicySourceArn: str,
ActionNames: Sequence[str],
PolicyInputList: Sequence[str] = ...,
PermissionsBoundaryPolicyInputList: Sequence[str] = ...,
ResourceArns: Sequence[str] = ...,
ResourcePolicy: str = ...,
ResourceOwner: str = ...,
CallerArn: str = ...,
ContextEntries: Sequence[ContextEntryTypeDef] = ..., # (1)
ResourceHandlingOption: str = ...,
MaxItems: int = ...,
Marker: str = ...,
) -> SimulatePolicyResponseTypeDef: # (2)
...
kwargs: SimulatePrincipalPolicyRequestRequestTypeDef = { # (1)
"PolicySourceArn": ...,
"ActionNames": ...,
}
parent.simulate_principal_policy(**kwargs)
tag_instance_profile
Adds one or more tags to an IAM instance profile.
Type annotations and code completion for session.client("iam").tag_instance_profile
method.
boto3 documentation
await def tag_instance_profile(
self,
*,
InstanceProfileName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
"Tags": ...,
}
parent.tag_instance_profile(**kwargs)
tag_mfa_device
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device.
Type annotations and code completion for session.client("iam").tag_mfa_device
method.
boto3 documentation
await def tag_mfa_device(
self,
*,
SerialNumber: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagMFADeviceRequestRequestTypeDef = { # (1)
"SerialNumber": ...,
"Tags": ...,
}
parent.tag_mfa_device(**kwargs)
tag_open_id_connect_provider
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider.
Type annotations and code completion for session.client("iam").tag_open_id_connect_provider
method.
boto3 documentation
await def tag_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
"Tags": ...,
}
parent.tag_open_id_connect_provider(**kwargs)
tag_policy
Adds one or more tags to an IAM customer managed policy.
Type annotations and code completion for session.client("iam").tag_policy
method.
boto3 documentation
await def tag_policy(
self,
*,
PolicyArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagPolicyRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
"Tags": ...,
}
parent.tag_policy(**kwargs)
tag_role
Adds one or more tags to an IAM role.
Type annotations and code completion for session.client("iam").tag_role
method.
boto3 documentation
await def tag_role(
self,
*,
RoleName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
"Tags": ...,
}
parent.tag_role(**kwargs)
tag_saml_provider
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.
Type annotations and code completion for session.client("iam").tag_saml_provider
method.
boto3 documentation
await def tag_saml_provider(
self,
*,
SAMLProviderArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagSAMLProviderRequestRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
"Tags": ...,
}
parent.tag_saml_provider(**kwargs)
tag_server_certificate
Adds one or more tags to an IAM server certificate.
Type annotations and code completion for session.client("iam").tag_server_certificate
method.
boto3 documentation
await def tag_server_certificate(
self,
*,
ServerCertificateName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagServerCertificateRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
"Tags": ...,
}
parent.tag_server_certificate(**kwargs)
tag_user
Adds one or more tags to an IAM user.
Type annotations and code completion for session.client("iam").tag_user
method.
boto3 documentation
await def tag_user(
self,
*,
UserName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"Tags": ...,
}
parent.tag_user(**kwargs)
untag_instance_profile
Removes the specified tags from the IAM instance profile.
Type annotations and code completion for session.client("iam").untag_instance_profile
method.
boto3 documentation
await def untag_instance_profile(
self,
*,
InstanceProfileName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagInstanceProfileRequestRequestTypeDef = { # (1)
"InstanceProfileName": ...,
"TagKeys": ...,
}
parent.untag_instance_profile(**kwargs)
untag_mfa_device
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.
Type annotations and code completion for session.client("iam").untag_mfa_device
method.
boto3 documentation
await def untag_mfa_device(
self,
*,
SerialNumber: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagMFADeviceRequestRequestTypeDef = { # (1)
"SerialNumber": ...,
"TagKeys": ...,
}
parent.untag_mfa_device(**kwargs)
untag_open_id_connect_provider
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM.
Type annotations and code completion for session.client("iam").untag_open_id_connect_provider
method.
boto3 documentation
await def untag_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagOpenIDConnectProviderRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
"TagKeys": ...,
}
parent.untag_open_id_connect_provider(**kwargs)
untag_policy
Removes the specified tags from the customer managed policy.
Type annotations and code completion for session.client("iam").untag_policy
method.
boto3 documentation
await def untag_policy(
self,
*,
PolicyArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagPolicyRequestRequestTypeDef = { # (1)
"PolicyArn": ...,
"TagKeys": ...,
}
parent.untag_policy(**kwargs)
untag_role
Removes the specified tags from the role.
Type annotations and code completion for session.client("iam").untag_role
method.
boto3 documentation
await def untag_role(
self,
*,
RoleName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
"TagKeys": ...,
}
parent.untag_role(**kwargs)
untag_saml_provider
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM.
Type annotations and code completion for session.client("iam").untag_saml_provider
method.
boto3 documentation
await def untag_saml_provider(
self,
*,
SAMLProviderArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagSAMLProviderRequestRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
"TagKeys": ...,
}
parent.untag_saml_provider(**kwargs)
untag_server_certificate
Removes the specified tags from the IAM server certificate.
Type annotations and code completion for session.client("iam").untag_server_certificate
method.
boto3 documentation
await def untag_server_certificate(
self,
*,
ServerCertificateName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagServerCertificateRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
"TagKeys": ...,
}
parent.untag_server_certificate(**kwargs)
untag_user
Removes the specified tags from the user.
Type annotations and code completion for session.client("iam").untag_user
method.
boto3 documentation
await def untag_user(
self,
*,
UserName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"TagKeys": ...,
}
parent.untag_user(**kwargs)
update_access_key
Changes the status of the specified access key from Active to Inactive, or vice versa.
Type annotations and code completion for session.client("iam").update_access_key
method.
boto3 documentation
await def update_access_key(
self,
*,
AccessKeyId: str,
Status: statusTypeType, # (1)
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateAccessKeyRequestRequestTypeDef = { # (1)
"AccessKeyId": ...,
"Status": ...,
}
parent.update_access_key(**kwargs)
update_account_password_policy
Updates the password policy settings for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").update_account_password_policy
method.
boto3 documentation
await def update_account_password_policy(
self,
*,
MinimumPasswordLength: int = ...,
RequireSymbols: bool = ...,
RequireNumbers: bool = ...,
RequireUppercaseCharacters: bool = ...,
RequireLowercaseCharacters: bool = ...,
AllowUsersToChangePassword: bool = ...,
MaxPasswordAge: int = ...,
PasswordReusePrevention: int = ...,
HardExpiry: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateAccountPasswordPolicyRequestRequestTypeDef = { # (1)
"MinimumPasswordLength": ...,
}
parent.update_account_password_policy(**kwargs)
update_assume_role_policy
Updates the policy that grants an IAM entity permission to assume a role.
Type annotations and code completion for session.client("iam").update_assume_role_policy
method.
boto3 documentation
await def update_assume_role_policy(
self,
*,
RoleName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateAssumeRolePolicyRequestRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyDocument": ...,
}
parent.update_assume_role_policy(**kwargs)
update_group
Updates the name and/or the path of the specified IAM group.
Type annotations and code completion for session.client("iam").update_group
method.
boto3 documentation
await def update_group(
self,
*,
GroupName: str,
NewPath: str = ...,
NewGroupName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.update_group(**kwargs)
update_login_profile
Changes the password for the specified IAM user.
Type annotations and code completion for session.client("iam").update_login_profile
method.
boto3 documentation
await def update_login_profile(
self,
*,
UserName: str,
Password: str = ...,
PasswordResetRequired: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateLoginProfileRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.update_login_profile(**kwargs)
update_open_id_connect_provider_thumbprint
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
Type annotations and code completion for session.client("iam").update_open_id_connect_provider_thumbprint
method.
boto3 documentation
await def update_open_id_connect_provider_thumbprint(
self,
*,
OpenIDConnectProviderArn: str,
ThumbprintList: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateOpenIDConnectProviderThumbprintRequestRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
"ThumbprintList": ...,
}
parent.update_open_id_connect_provider_thumbprint(**kwargs)
update_role
Updates the description or maximum session duration setting of a role.
Type annotations and code completion for session.client("iam").update_role
method.
boto3 documentation
await def update_role(
self,
*,
RoleName: str,
Description: str = ...,
MaxSessionDuration: int = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateRoleRequestRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.update_role(**kwargs)
update_role_description
Use UpdateRole instead.
Type annotations and code completion for session.client("iam").update_role_description
method.
boto3 documentation
await def update_role_description(
self,
*,
RoleName: str,
Description: str,
) -> UpdateRoleDescriptionResponseTypeDef: # (1)
...
kwargs: UpdateRoleDescriptionRequestRequestTypeDef = { # (1)
"RoleName": ...,
"Description": ...,
}
parent.update_role_description(**kwargs)
update_saml_provider
Updates the metadata document for an existing SAML provider resource object.
Type annotations and code completion for session.client("iam").update_saml_provider
method.
boto3 documentation
await def update_saml_provider(
self,
*,
SAMLMetadataDocument: str,
SAMLProviderArn: str,
) -> UpdateSAMLProviderResponseTypeDef: # (1)
...
kwargs: UpdateSAMLProviderRequestRequestTypeDef = { # (1)
"SAMLMetadataDocument": ...,
"SAMLProviderArn": ...,
}
parent.update_saml_provider(**kwargs)
update_server_certificate
Updates the name and/or the path of the specified server certificate stored in IAM.
Type annotations and code completion for session.client("iam").update_server_certificate
method.
boto3 documentation
await def update_server_certificate(
self,
*,
ServerCertificateName: str,
NewPath: str = ...,
NewServerCertificateName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateServerCertificateRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
}
parent.update_server_certificate(**kwargs)
update_service_specific_credential
Sets the status of a service-specific credential to Active
or Inactive
.
Type annotations and code completion for session.client("iam").update_service_specific_credential
method.
boto3 documentation
await def update_service_specific_credential(
self,
*,
ServiceSpecificCredentialId: str,
Status: statusTypeType, # (1)
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateServiceSpecificCredentialRequestRequestTypeDef = { # (1)
"ServiceSpecificCredentialId": ...,
"Status": ...,
}
parent.update_service_specific_credential(**kwargs)
update_signing_certificate
Changes the status of the specified user signing certificate from active to disabled, or vice versa.
Type annotations and code completion for session.client("iam").update_signing_certificate
method.
boto3 documentation
await def update_signing_certificate(
self,
*,
CertificateId: str,
Status: statusTypeType, # (1)
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateSigningCertificateRequestRequestTypeDef = { # (1)
"CertificateId": ...,
"Status": ...,
}
parent.update_signing_certificate(**kwargs)
update_ssh_public_key
Sets the status of an IAM user's SSH public key to active or inactive.
Type annotations and code completion for session.client("iam").update_ssh_public_key
method.
boto3 documentation
await def update_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyId: str,
Status: statusTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateSSHPublicKeyRequestRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyId": ...,
"Status": ...,
}
parent.update_ssh_public_key(**kwargs)
update_user
Updates the name and/or the path of the specified IAM user.
Type annotations and code completion for session.client("iam").update_user
method.
boto3 documentation
await def update_user(
self,
*,
UserName: str,
NewPath: str = ...,
NewUserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.update_user(**kwargs)
upload_server_certificate
Uploads a server certificate entity for the Amazon Web Services account.
Type annotations and code completion for session.client("iam").upload_server_certificate
method.
boto3 documentation
await def upload_server_certificate(
self,
*,
ServerCertificateName: str,
CertificateBody: str,
PrivateKey: str,
Path: str = ...,
CertificateChain: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> UploadServerCertificateResponseTypeDef: # (2)
...
kwargs: UploadServerCertificateRequestRequestTypeDef = { # (1)
"ServerCertificateName": ...,
"CertificateBody": ...,
"PrivateKey": ...,
}
parent.upload_server_certificate(**kwargs)
upload_signing_certificate
Uploads an X.509 signing certificate and associates it with the specified IAM user.
Type annotations and code completion for session.client("iam").upload_signing_certificate
method.
boto3 documentation
await def upload_signing_certificate(
self,
*,
CertificateBody: str,
UserName: str = ...,
) -> UploadSigningCertificateResponseTypeDef: # (1)
...
kwargs: UploadSigningCertificateRequestRequestTypeDef = { # (1)
"CertificateBody": ...,
}
parent.upload_signing_certificate(**kwargs)
upload_ssh_public_key
Uploads an SSH public key and associates it with the specified IAM user.
Type annotations and code completion for session.client("iam").upload_ssh_public_key
method.
boto3 documentation
await def upload_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyBody: str,
) -> UploadSSHPublicKeyResponseTypeDef: # (1)
...
kwargs: UploadSSHPublicKeyRequestRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyBody": ...,
}
parent.upload_ssh_public_key(**kwargs)
__aenter__
Type annotations and code completion for session.client("iam").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("iam").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("iam").get_paginator
method with overloads.
client.get_paginator("get_account_authorization_details")
-> GetAccountAuthorizationDetailsPaginatorclient.get_paginator("get_group")
-> GetGroupPaginatorclient.get_paginator("list_access_keys")
-> ListAccessKeysPaginatorclient.get_paginator("list_account_aliases")
-> ListAccountAliasesPaginatorclient.get_paginator("list_attached_group_policies")
-> ListAttachedGroupPoliciesPaginatorclient.get_paginator("list_attached_role_policies")
-> ListAttachedRolePoliciesPaginatorclient.get_paginator("list_attached_user_policies")
-> ListAttachedUserPoliciesPaginatorclient.get_paginator("list_entities_for_policy")
-> ListEntitiesForPolicyPaginatorclient.get_paginator("list_group_policies")
-> ListGroupPoliciesPaginatorclient.get_paginator("list_groups")
-> ListGroupsPaginatorclient.get_paginator("list_groups_for_user")
-> ListGroupsForUserPaginatorclient.get_paginator("list_instance_profiles")
-> ListInstanceProfilesPaginatorclient.get_paginator("list_instance_profiles_for_role")
-> ListInstanceProfilesForRolePaginatorclient.get_paginator("list_mfa_devices")
-> ListMFADevicesPaginatorclient.get_paginator("list_policies")
-> ListPoliciesPaginatorclient.get_paginator("list_policy_versions")
-> ListPolicyVersionsPaginatorclient.get_paginator("list_role_policies")
-> ListRolePoliciesPaginatorclient.get_paginator("list_roles")
-> ListRolesPaginatorclient.get_paginator("list_ssh_public_keys")
-> ListSSHPublicKeysPaginatorclient.get_paginator("list_server_certificates")
-> ListServerCertificatesPaginatorclient.get_paginator("list_signing_certificates")
-> ListSigningCertificatesPaginatorclient.get_paginator("list_user_policies")
-> ListUserPoliciesPaginatorclient.get_paginator("list_user_tags")
-> ListUserTagsPaginatorclient.get_paginator("list_users")
-> ListUsersPaginatorclient.get_paginator("list_virtual_mfa_devices")
-> ListVirtualMFADevicesPaginatorclient.get_paginator("simulate_custom_policy")
-> SimulateCustomPolicyPaginatorclient.get_paginator("simulate_principal_policy")
-> SimulatePrincipalPolicyPaginator
get_waiter
Type annotations and code completion for session.client("iam").get_waiter
method with overloads.
client.get_waiter("instance_profile_exists")
-> InstanceProfileExistsWaiterclient.get_waiter("policy_exists")
-> PolicyExistsWaiterclient.get_waiter("role_exists")
-> RoleExistsWaiterclient.get_waiter("user_exists")
-> UserExistsWaiter