IAMClient#
Auto-generated documentation for IAM type annotations stubs module mypy-boto3-iam.
IAMClient#
Type annotations and code completion for boto3.client("iam").
boto3 documentation
# IAMClient usage example
from boto3.session import Session
from mypy_boto3_iam.client import IAMClient
def get_iam_client() -> IAMClient:
return Session().client("iam")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("iam").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("iam")
try:
do_something(client)
except (
client.exceptions.AccountNotManagementOrDelegatedAdministratorException,
client.exceptions.CallerIsNotManagementAccountException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.CredentialReportExpiredException,
client.exceptions.CredentialReportNotPresentException,
client.exceptions.CredentialReportNotReadyException,
client.exceptions.DeleteConflictException,
client.exceptions.DuplicateCertificateException,
client.exceptions.DuplicateSSHPublicKeyException,
client.exceptions.EntityAlreadyExistsException,
client.exceptions.EntityTemporarilyUnmodifiableException,
client.exceptions.InvalidAuthenticationCodeException,
client.exceptions.InvalidCertificateException,
client.exceptions.InvalidInputException,
client.exceptions.InvalidPublicKeyException,
client.exceptions.InvalidUserTypeException,
client.exceptions.KeyPairMismatchException,
client.exceptions.LimitExceededException,
client.exceptions.MalformedCertificateException,
client.exceptions.MalformedPolicyDocumentException,
client.exceptions.NoSuchEntityException,
client.exceptions.OpenIdIdpCommunicationErrorException,
client.exceptions.OrganizationNotFoundException,
client.exceptions.OrganizationNotInAllFeaturesModeException,
client.exceptions.PasswordPolicyViolationException,
client.exceptions.PolicyEvaluationException,
client.exceptions.PolicyNotAttachableException,
client.exceptions.ReportGenerationLimitExceededException,
client.exceptions.ServiceAccessNotEnabledException,
client.exceptions.ServiceFailureException,
client.exceptions.ServiceNotSupportedException,
client.exceptions.UnmodifiableEntityException,
client.exceptions.UnrecognizedPublicKeyEncodingException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_iam.client import Exceptions
def handle_error(exc: Exceptions.AccountNotManagementOrDelegatedAdministratorException) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("iam").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("iam").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...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 boto3.client("iam").add_client_id_to_open_id_connect_provider method.
boto3 documentation
# add_client_id_to_open_id_connect_provider method definition
def add_client_id_to_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
ClientID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# add_client_id_to_open_id_connect_provider method usage example with argument unpacking
kwargs: AddClientIDToOpenIDConnectProviderRequestTypeDef = { # (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 boto3.client("iam").add_role_to_instance_profile method.
boto3 documentation
# add_role_to_instance_profile method definition
def add_role_to_instance_profile(
self,
*,
InstanceProfileName: str,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# add_role_to_instance_profile method usage example with argument unpacking
kwargs: AddRoleToInstanceProfileRequestTypeDef = { # (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 boto3.client("iam").add_user_to_group method.
boto3 documentation
# add_user_to_group method definition
def add_user_to_group(
self,
*,
GroupName: str,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# add_user_to_group method usage example with argument unpacking
kwargs: AddUserToGroupRequestTypeDef = { # (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 boto3.client("iam").attach_group_policy method.
boto3 documentation
# attach_group_policy method definition
def attach_group_policy(
self,
*,
GroupName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# attach_group_policy method usage example with argument unpacking
kwargs: AttachGroupPolicyRequestTypeDef = { # (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 boto3.client("iam").attach_role_policy method.
boto3 documentation
# attach_role_policy method definition
def attach_role_policy(
self,
*,
RoleName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# attach_role_policy method usage example with argument unpacking
kwargs: AttachRolePolicyRequestTypeDef = { # (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 boto3.client("iam").attach_user_policy method.
boto3 documentation
# attach_user_policy method definition
def attach_user_policy(
self,
*,
UserName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# attach_user_policy method usage example with argument unpacking
kwargs: AttachUserPolicyRequestTypeDef = { # (1)
"UserName": ...,
"PolicyArn": ...,
}
parent.attach_user_policy(**kwargs)change_password#
Changes the password of the IAM user who is calling this operation.
Type annotations and code completion for boto3.client("iam").change_password method.
boto3 documentation
# change_password method definition
def change_password(
self,
*,
OldPassword: str,
NewPassword: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# change_password method usage example with argument unpacking
kwargs: ChangePasswordRequestTypeDef = { # (1)
"OldPassword": ...,
"NewPassword": ...,
}
parent.change_password(**kwargs)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 boto3.client("iam").create_access_key method.
boto3 documentation
# create_access_key method definition
def create_access_key(
self,
*,
UserName: str = ...,
) -> CreateAccessKeyResponseTypeDef: # (1)
...# create_access_key method usage example with argument unpacking
kwargs: CreateAccessKeyRequestTypeDef = { # (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 boto3.client("iam").create_account_alias method.
boto3 documentation
# create_account_alias method definition
def create_account_alias(
self,
*,
AccountAlias: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# create_account_alias method usage example with argument unpacking
kwargs: CreateAccountAliasRequestTypeDef = { # (1)
"AccountAlias": ...,
}
parent.create_account_alias(**kwargs)create_group#
Creates a new group.
Type annotations and code completion for boto3.client("iam").create_group method.
boto3 documentation
# create_group method definition
def create_group(
self,
*,
GroupName: str,
Path: str = ...,
) -> CreateGroupResponseTypeDef: # (1)
...# create_group method usage example with argument unpacking
kwargs: CreateGroupRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.create_group(**kwargs)create_instance_profile#
Creates a new instance profile.
Type annotations and code completion for boto3.client("iam").create_instance_profile method.
boto3 documentation
# create_instance_profile method definition
def create_instance_profile(
self,
*,
InstanceProfileName: str,
Path: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateInstanceProfileResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateInstanceProfileResponseTypeDef
# create_instance_profile method usage example with argument unpacking
kwargs: CreateInstanceProfileRequestTypeDef = { # (1)
"InstanceProfileName": ...,
}
parent.create_instance_profile(**kwargs)create_login_profile#
Creates a password for the specified IAM user.
Type annotations and code completion for boto3.client("iam").create_login_profile method.
boto3 documentation
# create_login_profile method definition
def create_login_profile(
self,
*,
UserName: str = ...,
Password: str = ...,
PasswordResetRequired: bool = ...,
) -> CreateLoginProfileResponseTypeDef: # (1)
...# create_login_profile method usage example with argument unpacking
kwargs: CreateLoginProfileRequestTypeDef = { # (1)
"UserName": ...,
}
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).
Type annotations and code completion for boto3.client("iam").create_open_id_connect_provider method.
boto3 documentation
# create_open_id_connect_provider method definition
def create_open_id_connect_provider(
self,
*,
Url: str,
ClientIDList: Sequence[str] = ...,
ThumbprintList: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateOpenIDConnectProviderResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateOpenIDConnectProviderResponseTypeDef
# create_open_id_connect_provider method usage example with argument unpacking
kwargs: CreateOpenIDConnectProviderRequestTypeDef = { # (1)
"Url": ...,
}
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 boto3.client("iam").create_policy method.
boto3 documentation
# create_policy method definition
def create_policy(
self,
*,
PolicyName: str,
PolicyDocument: str,
Path: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePolicyResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreatePolicyResponseTypeDef
# create_policy method usage example with argument unpacking
kwargs: CreatePolicyRequestTypeDef = { # (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 boto3.client("iam").create_policy_version method.
boto3 documentation
# create_policy_version method definition
def create_policy_version(
self,
*,
PolicyArn: str,
PolicyDocument: str,
SetAsDefault: bool = ...,
) -> CreatePolicyVersionResponseTypeDef: # (1)
...# create_policy_version method usage example with argument unpacking
kwargs: CreatePolicyVersionRequestTypeDef = { # (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 boto3.client("iam").create_role method.
boto3 documentation
# create_role method definition
def create_role(
self,
*,
RoleName: str,
AssumeRolePolicyDocument: str,
Path: str = ...,
Description: str = ...,
MaxSessionDuration: int = ...,
PermissionsBoundary: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateRoleResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateRoleResponseTypeDef
# create_role method usage example with argument unpacking
kwargs: CreateRoleRequestTypeDef = { # (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 boto3.client("iam").create_saml_provider method.
boto3 documentation
# create_saml_provider method definition
def create_saml_provider(
self,
*,
SAMLMetadataDocument: str,
Name: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
AssertionEncryptionMode: AssertionEncryptionModeTypeType = ..., # (2)
AddPrivateKey: str = ...,
) -> CreateSAMLProviderResponseTypeDef: # (3)
...- See
Sequence[TagTypeDef] - See AssertionEncryptionModeTypeType
- See CreateSAMLProviderResponseTypeDef
# create_saml_provider method usage example with argument unpacking
kwargs: CreateSAMLProviderRequestTypeDef = { # (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 boto3.client("iam").create_service_linked_role method.
boto3 documentation
# create_service_linked_role method definition
def create_service_linked_role(
self,
*,
AWSServiceName: str,
Description: str = ...,
CustomSuffix: str = ...,
) -> CreateServiceLinkedRoleResponseTypeDef: # (1)
...# create_service_linked_role method usage example with argument unpacking
kwargs: CreateServiceLinkedRoleRequestTypeDef = { # (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 boto3.client("iam").create_service_specific_credential method.
boto3 documentation
# create_service_specific_credential method definition
def create_service_specific_credential(
self,
*,
UserName: str,
ServiceName: str,
CredentialAgeDays: int = ...,
) -> CreateServiceSpecificCredentialResponseTypeDef: # (1)
...# create_service_specific_credential method usage example with argument unpacking
kwargs: CreateServiceSpecificCredentialRequestTypeDef = { # (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 boto3.client("iam").create_user method.
boto3 documentation
# create_user method definition
def create_user(
self,
*,
UserName: str,
Path: str = ...,
PermissionsBoundary: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateUserResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateUserResponseTypeDef
# create_user method usage example with argument unpacking
kwargs: CreateUserRequestTypeDef = { # (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 boto3.client("iam").create_virtual_mfa_device method.
boto3 documentation
# create_virtual_mfa_device method definition
def create_virtual_mfa_device(
self,
*,
VirtualMFADeviceName: str,
Path: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateVirtualMFADeviceResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateVirtualMFADeviceResponseTypeDef
# create_virtual_mfa_device method usage example with argument unpacking
kwargs: CreateVirtualMFADeviceRequestTypeDef = { # (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 boto3.client("iam").deactivate_mfa_device method.
boto3 documentation
# deactivate_mfa_device method definition
def deactivate_mfa_device(
self,
*,
SerialNumber: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# deactivate_mfa_device method usage example with argument unpacking
kwargs: DeactivateMFADeviceRequestTypeDef = { # (1)
"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 boto3.client("iam").delete_access_key method.
boto3 documentation
# delete_access_key method definition
def delete_access_key(
self,
*,
AccessKeyId: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_access_key method usage example with argument unpacking
kwargs: DeleteAccessKeyRequestTypeDef = { # (1)
"AccessKeyId": ...,
}
parent.delete_access_key(**kwargs)delete_account_alias#
Deletes the specified Amazon Web Services account alias.
Type annotations and code completion for boto3.client("iam").delete_account_alias method.
boto3 documentation
# delete_account_alias method definition
def delete_account_alias(
self,
*,
AccountAlias: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_account_alias method usage example with argument unpacking
kwargs: DeleteAccountAliasRequestTypeDef = { # (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 boto3.client("iam").delete_account_password_policy method.
boto3 documentation
# delete_account_password_policy method definition
def delete_account_password_policy(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...delete_group#
Deletes the specified IAM group.
Type annotations and code completion for boto3.client("iam").delete_group method.
boto3 documentation
# delete_group method definition
def delete_group(
self,
*,
GroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_group method usage example with argument unpacking
kwargs: DeleteGroupRequestTypeDef = { # (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 boto3.client("iam").delete_group_policy method.
boto3 documentation
# delete_group_policy method definition
def delete_group_policy(
self,
*,
GroupName: str,
PolicyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_group_policy method usage example with argument unpacking
kwargs: DeleteGroupPolicyRequestTypeDef = { # (1)
"GroupName": ...,
"PolicyName": ...,
}
parent.delete_group_policy(**kwargs)delete_instance_profile#
Deletes the specified instance profile.
Type annotations and code completion for boto3.client("iam").delete_instance_profile method.
boto3 documentation
# delete_instance_profile method definition
def delete_instance_profile(
self,
*,
InstanceProfileName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_instance_profile method usage example with argument unpacking
kwargs: DeleteInstanceProfileRequestTypeDef = { # (1)
"InstanceProfileName": ...,
}
parent.delete_instance_profile(**kwargs)delete_login_profile#
Deletes the password for the specified IAM user or root user, For more information, see Managing passwords for IAM users.
Type annotations and code completion for boto3.client("iam").delete_login_profile method.
boto3 documentation
# delete_login_profile method definition
def delete_login_profile(
self,
*,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_login_profile method usage example with argument unpacking
kwargs: DeleteLoginProfileRequestTypeDef = { # (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 boto3.client("iam").delete_open_id_connect_provider method.
boto3 documentation
# delete_open_id_connect_provider method definition
def delete_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_open_id_connect_provider method usage example with argument unpacking
kwargs: DeleteOpenIDConnectProviderRequestTypeDef = { # (1)
"OpenIDConnectProviderArn": ...,
}
parent.delete_open_id_connect_provider(**kwargs)delete_policy#
Deletes the specified managed policy.
Type annotations and code completion for boto3.client("iam").delete_policy method.
boto3 documentation
# delete_policy method definition
def delete_policy(
self,
*,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_policy method usage example with argument unpacking
kwargs: DeletePolicyRequestTypeDef = { # (1)
"PolicyArn": ...,
}
parent.delete_policy(**kwargs)delete_policy_version#
Deletes the specified version from the specified managed policy.
Type annotations and code completion for boto3.client("iam").delete_policy_version method.
boto3 documentation
# delete_policy_version method definition
def delete_policy_version(
self,
*,
PolicyArn: str,
VersionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_policy_version method usage example with argument unpacking
kwargs: DeletePolicyVersionRequestTypeDef = { # (1)
"PolicyArn": ...,
"VersionId": ...,
}
parent.delete_policy_version(**kwargs)delete_role#
Deletes the specified role.
Type annotations and code completion for boto3.client("iam").delete_role method.
boto3 documentation
# delete_role method definition
def delete_role(
self,
*,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_role method usage example with argument unpacking
kwargs: DeleteRoleRequestTypeDef = { # (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 boto3.client("iam").delete_role_permissions_boundary method.
boto3 documentation
# delete_role_permissions_boundary method definition
def delete_role_permissions_boundary(
self,
*,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_role_permissions_boundary method usage example with argument unpacking
kwargs: DeleteRolePermissionsBoundaryRequestTypeDef = { # (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 boto3.client("iam").delete_role_policy method.
boto3 documentation
# delete_role_policy method definition
def delete_role_policy(
self,
*,
RoleName: str,
PolicyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_role_policy method usage example with argument unpacking
kwargs: DeleteRolePolicyRequestTypeDef = { # (1)
"RoleName": ...,
"PolicyName": ...,
}
parent.delete_role_policy(**kwargs)delete_saml_provider#
Deletes a SAML provider resource in IAM.
Type annotations and code completion for boto3.client("iam").delete_saml_provider method.
boto3 documentation
# delete_saml_provider method definition
def delete_saml_provider(
self,
*,
SAMLProviderArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_saml_provider method usage example with argument unpacking
kwargs: DeleteSAMLProviderRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
}
parent.delete_saml_provider(**kwargs)delete_ssh_public_key#
Deletes the specified SSH public key.
Type annotations and code completion for boto3.client("iam").delete_ssh_public_key method.
boto3 documentation
# delete_ssh_public_key method definition
def delete_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_ssh_public_key method usage example with argument unpacking
kwargs: DeleteSSHPublicKeyRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyId": ...,
}
parent.delete_ssh_public_key(**kwargs)delete_server_certificate#
Deletes the specified server certificate.
Type annotations and code completion for boto3.client("iam").delete_server_certificate method.
boto3 documentation
# delete_server_certificate method definition
def delete_server_certificate(
self,
*,
ServerCertificateName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_server_certificate method usage example with argument unpacking
kwargs: DeleteServerCertificateRequestTypeDef = { # (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 boto3.client("iam").delete_service_linked_role method.
boto3 documentation
# delete_service_linked_role method definition
def delete_service_linked_role(
self,
*,
RoleName: str,
) -> DeleteServiceLinkedRoleResponseTypeDef: # (1)
...# delete_service_linked_role method usage example with argument unpacking
kwargs: DeleteServiceLinkedRoleRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.delete_service_linked_role(**kwargs)delete_service_specific_credential#
Deletes the specified service-specific credential.
Type annotations and code completion for boto3.client("iam").delete_service_specific_credential method.
boto3 documentation
# delete_service_specific_credential method definition
def delete_service_specific_credential(
self,
*,
ServiceSpecificCredentialId: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_service_specific_credential method usage example with argument unpacking
kwargs: DeleteServiceSpecificCredentialRequestTypeDef = { # (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 boto3.client("iam").delete_signing_certificate method.
boto3 documentation
# delete_signing_certificate method definition
def delete_signing_certificate(
self,
*,
CertificateId: str,
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_signing_certificate method usage example with argument unpacking
kwargs: DeleteSigningCertificateRequestTypeDef = { # (1)
"CertificateId": ...,
}
parent.delete_signing_certificate(**kwargs)delete_user#
Deletes the specified IAM user.
Type annotations and code completion for boto3.client("iam").delete_user method.
boto3 documentation
# delete_user method definition
def delete_user(
self,
*,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestTypeDef = { # (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 boto3.client("iam").delete_user_permissions_boundary method.
boto3 documentation
# delete_user_permissions_boundary method definition
def delete_user_permissions_boundary(
self,
*,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_user_permissions_boundary method usage example with argument unpacking
kwargs: DeleteUserPermissionsBoundaryRequestTypeDef = { # (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 boto3.client("iam").delete_user_policy method.
boto3 documentation
# delete_user_policy method definition
def delete_user_policy(
self,
*,
UserName: str,
PolicyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_user_policy method usage example with argument unpacking
kwargs: DeleteUserPolicyRequestTypeDef = { # (1)
"UserName": ...,
"PolicyName": ...,
}
parent.delete_user_policy(**kwargs)delete_virtual_mfa_device#
Deletes a virtual MFA device.
Type annotations and code completion for boto3.client("iam").delete_virtual_mfa_device method.
boto3 documentation
# delete_virtual_mfa_device method definition
def delete_virtual_mfa_device(
self,
*,
SerialNumber: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_virtual_mfa_device method usage example with argument unpacking
kwargs: DeleteVirtualMFADeviceRequestTypeDef = { # (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 boto3.client("iam").detach_group_policy method.
boto3 documentation
# detach_group_policy method definition
def detach_group_policy(
self,
*,
GroupName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# detach_group_policy method usage example with argument unpacking
kwargs: DetachGroupPolicyRequestTypeDef = { # (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 boto3.client("iam").detach_role_policy method.
boto3 documentation
# detach_role_policy method definition
def detach_role_policy(
self,
*,
RoleName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# detach_role_policy method usage example with argument unpacking
kwargs: DetachRolePolicyRequestTypeDef = { # (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 boto3.client("iam").detach_user_policy method.
boto3 documentation
# detach_user_policy method definition
def detach_user_policy(
self,
*,
UserName: str,
PolicyArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# detach_user_policy method usage example with argument unpacking
kwargs: DetachUserPolicyRequestTypeDef = { # (1)
"UserName": ...,
"PolicyArn": ...,
}
parent.detach_user_policy(**kwargs)disable_organizations_root_credentials_management#
Disables the management of privileged root user credentials across member accounts in your organization.
Type annotations and code completion for boto3.client("iam").disable_organizations_root_credentials_management method.
boto3 documentation
# disable_organizations_root_credentials_management method definition
def disable_organizations_root_credentials_management(
self,
) -> DisableOrganizationsRootCredentialsManagementResponseTypeDef: # (1)
...disable_organizations_root_sessions#
Disables root user sessions for privileged tasks across member accounts in your organization.
Type annotations and code completion for boto3.client("iam").disable_organizations_root_sessions method.
boto3 documentation
# disable_organizations_root_sessions method definition
def disable_organizations_root_sessions(
self,
) -> DisableOrganizationsRootSessionsResponseTypeDef: # (1)
...enable_mfa_device#
Enables the specified MFA device and associates it with the specified IAM user.
Type annotations and code completion for boto3.client("iam").enable_mfa_device method.
boto3 documentation
# enable_mfa_device method definition
def enable_mfa_device(
self,
*,
UserName: str,
SerialNumber: str,
AuthenticationCode1: str,
AuthenticationCode2: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# enable_mfa_device method usage example with argument unpacking
kwargs: EnableMFADeviceRequestTypeDef = { # (1)
"UserName": ...,
"SerialNumber": ...,
"AuthenticationCode1": ...,
"AuthenticationCode2": ...,
}
parent.enable_mfa_device(**kwargs)enable_organizations_root_credentials_management#
Enables the management of privileged root user credentials across member accounts in your organization.
Type annotations and code completion for boto3.client("iam").enable_organizations_root_credentials_management method.
boto3 documentation
# enable_organizations_root_credentials_management method definition
def enable_organizations_root_credentials_management(
self,
) -> EnableOrganizationsRootCredentialsManagementResponseTypeDef: # (1)
...enable_organizations_root_sessions#
Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization.
Type annotations and code completion for boto3.client("iam").enable_organizations_root_sessions method.
boto3 documentation
# enable_organizations_root_sessions method definition
def enable_organizations_root_sessions(
self,
) -> EnableOrganizationsRootSessionsResponseTypeDef: # (1)
...generate_credential_report#
Generates a credential report for the Amazon Web Services account.
Type annotations and code completion for boto3.client("iam").generate_credential_report method.
boto3 documentation
# generate_credential_report method definition
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 boto3.client("iam").generate_organizations_access_report method.
boto3 documentation
# generate_organizations_access_report method definition
def generate_organizations_access_report(
self,
*,
EntityPath: str,
OrganizationsPolicyId: str = ...,
) -> GenerateOrganizationsAccessReportResponseTypeDef: # (1)
...# generate_organizations_access_report method usage example with argument unpacking
kwargs: GenerateOrganizationsAccessReportRequestTypeDef = { # (1)
"EntityPath": ...,
}
parent.generate_organizations_access_report(**kwargs)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 boto3.client("iam").generate_service_last_accessed_details method.
boto3 documentation
# generate_service_last_accessed_details method definition
def generate_service_last_accessed_details(
self,
*,
Arn: str,
Granularity: AccessAdvisorUsageGranularityTypeType = ..., # (1)
) -> GenerateServiceLastAccessedDetailsResponseTypeDef: # (2)
...# generate_service_last_accessed_details method usage example with argument unpacking
kwargs: GenerateServiceLastAccessedDetailsRequestTypeDef = { # (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 boto3.client("iam").get_access_key_last_used method.
boto3 documentation
# get_access_key_last_used method definition
def get_access_key_last_used(
self,
*,
AccessKeyId: str,
) -> GetAccessKeyLastUsedResponseTypeDef: # (1)
...# get_access_key_last_used method usage example with argument unpacking
kwargs: GetAccessKeyLastUsedRequestTypeDef = { # (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 boto3.client("iam").get_account_authorization_details method.
boto3 documentation
# get_account_authorization_details method definition
def get_account_authorization_details(
self,
*,
Filter: Sequence[EntityTypeType] = ..., # (1)
MaxItems: int = ...,
Marker: str = ...,
) -> GetAccountAuthorizationDetailsResponseTypeDef: # (2)
...- See
Sequence[EntityTypeType] - See GetAccountAuthorizationDetailsResponseTypeDef
# get_account_authorization_details method usage example with argument unpacking
kwargs: GetAccountAuthorizationDetailsRequestTypeDef = { # (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 boto3.client("iam").get_account_password_policy method.
boto3 documentation
# get_account_password_policy method definition
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 boto3.client("iam").get_account_summary method.
boto3 documentation
# get_account_summary method definition
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 boto3.client("iam").get_context_keys_for_custom_policy method.
boto3 documentation
# get_context_keys_for_custom_policy method definition
def get_context_keys_for_custom_policy(
self,
*,
PolicyInputList: Sequence[str],
) -> GetContextKeysForPolicyResponseTypeDef: # (1)
...# get_context_keys_for_custom_policy method usage example with argument unpacking
kwargs: GetContextKeysForCustomPolicyRequestTypeDef = { # (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 boto3.client("iam").get_context_keys_for_principal_policy method.
boto3 documentation
# get_context_keys_for_principal_policy method definition
def get_context_keys_for_principal_policy(
self,
*,
PolicySourceArn: str,
PolicyInputList: Sequence[str] = ...,
) -> GetContextKeysForPolicyResponseTypeDef: # (1)
...# get_context_keys_for_principal_policy method usage example with argument unpacking
kwargs: GetContextKeysForPrincipalPolicyRequestTypeDef = { # (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 boto3.client("iam").get_credential_report method.
boto3 documentation
# get_credential_report method definition
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 boto3.client("iam").get_group method.
boto3 documentation
# get_group method definition
def get_group(
self,
*,
GroupName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> GetGroupResponseTypeDef: # (1)
...# get_group method usage example with argument unpacking
kwargs: GetGroupRequestTypeDef = { # (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 boto3.client("iam").get_group_policy method.
boto3 documentation
# get_group_policy method definition
def get_group_policy(
self,
*,
GroupName: str,
PolicyName: str,
) -> GetGroupPolicyResponseTypeDef: # (1)
...# get_group_policy method usage example with argument unpacking
kwargs: GetGroupPolicyRequestTypeDef = { # (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 boto3.client("iam").get_instance_profile method.
boto3 documentation
# get_instance_profile method definition
def get_instance_profile(
self,
*,
InstanceProfileName: str,
) -> GetInstanceProfileResponseTypeDef: # (1)
...# get_instance_profile method usage example with argument unpacking
kwargs: GetInstanceProfileRequestTypeDef = { # (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 boto3.client("iam").get_login_profile method.
boto3 documentation
# get_login_profile method definition
def get_login_profile(
self,
*,
UserName: str = ...,
) -> GetLoginProfileResponseTypeDef: # (1)
...# get_login_profile method usage example with argument unpacking
kwargs: GetLoginProfileRequestTypeDef = { # (1)
"UserName": ...,
}
parent.get_login_profile(**kwargs)get_mfa_device#
Retrieves information about an MFA device for a specified user.
Type annotations and code completion for boto3.client("iam").get_mfa_device method.
boto3 documentation
# get_mfa_device method definition
def get_mfa_device(
self,
*,
SerialNumber: str,
UserName: str = ...,
) -> GetMFADeviceResponseTypeDef: # (1)
...# get_mfa_device method usage example with argument unpacking
kwargs: GetMFADeviceRequestTypeDef = { # (1)
"SerialNumber": ...,
}
parent.get_mfa_device(**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 boto3.client("iam").get_open_id_connect_provider method.
boto3 documentation
# get_open_id_connect_provider method definition
def get_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
) -> GetOpenIDConnectProviderResponseTypeDef: # (1)
...# get_open_id_connect_provider method usage example with argument unpacking
kwargs: GetOpenIDConnectProviderRequestTypeDef = { # (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 boto3.client("iam").get_organizations_access_report method.
boto3 documentation
# get_organizations_access_report method definition
def get_organizations_access_report(
self,
*,
JobId: str,
MaxItems: int = ...,
Marker: str = ...,
SortKey: SortKeyTypeType = ..., # (1)
) -> GetOrganizationsAccessReportResponseTypeDef: # (2)
...# get_organizations_access_report method usage example with argument unpacking
kwargs: GetOrganizationsAccessReportRequestTypeDef = { # (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 boto3.client("iam").get_policy method.
boto3 documentation
# get_policy method definition
def get_policy(
self,
*,
PolicyArn: str,
) -> GetPolicyResponseTypeDef: # (1)
...# get_policy method usage example with argument unpacking
kwargs: GetPolicyRequestTypeDef = { # (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 boto3.client("iam").get_policy_version method.
boto3 documentation
# get_policy_version method definition
def get_policy_version(
self,
*,
PolicyArn: str,
VersionId: str,
) -> GetPolicyVersionResponseTypeDef: # (1)
...# get_policy_version method usage example with argument unpacking
kwargs: GetPolicyVersionRequestTypeDef = { # (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 boto3.client("iam").get_role method.
boto3 documentation
# get_role method definition
def get_role(
self,
*,
RoleName: str,
) -> GetRoleResponseTypeDef: # (1)
...# get_role method usage example with argument unpacking
kwargs: GetRoleRequestTypeDef = { # (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 boto3.client("iam").get_role_policy method.
boto3 documentation
# get_role_policy method definition
def get_role_policy(
self,
*,
RoleName: str,
PolicyName: str,
) -> GetRolePolicyResponseTypeDef: # (1)
...# get_role_policy method usage example with argument unpacking
kwargs: GetRolePolicyRequestTypeDef = { # (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 boto3.client("iam").get_saml_provider method.
boto3 documentation
# get_saml_provider method definition
def get_saml_provider(
self,
*,
SAMLProviderArn: str,
) -> GetSAMLProviderResponseTypeDef: # (1)
...# get_saml_provider method usage example with argument unpacking
kwargs: GetSAMLProviderRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
}
parent.get_saml_provider(**kwargs)get_ssh_public_key#
Retrieves the specified SSH public key, including metadata about the key.
Type annotations and code completion for boto3.client("iam").get_ssh_public_key method.
boto3 documentation
# get_ssh_public_key method definition
def get_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyId: str,
Encoding: EncodingTypeType, # (1)
) -> GetSSHPublicKeyResponseTypeDef: # (2)
...# get_ssh_public_key method usage example with argument unpacking
kwargs: GetSSHPublicKeyRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyId": ...,
"Encoding": ...,
}
parent.get_ssh_public_key(**kwargs)get_server_certificate#
Retrieves information about the specified server certificate stored in IAM.
Type annotations and code completion for boto3.client("iam").get_server_certificate method.
boto3 documentation
# get_server_certificate method definition
def get_server_certificate(
self,
*,
ServerCertificateName: str,
) -> GetServerCertificateResponseTypeDef: # (1)
...# get_server_certificate method usage example with argument unpacking
kwargs: GetServerCertificateRequestTypeDef = { # (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 boto3.client("iam").get_service_last_accessed_details method.
boto3 documentation
# get_service_last_accessed_details method definition
def get_service_last_accessed_details(
self,
*,
JobId: str,
MaxItems: int = ...,
Marker: str = ...,
) -> GetServiceLastAccessedDetailsResponseTypeDef: # (1)
...# get_service_last_accessed_details method usage example with argument unpacking
kwargs: GetServiceLastAccessedDetailsRequestTypeDef = { # (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 boto3.client("iam").get_service_last_accessed_details_with_entities method.
boto3 documentation
# get_service_last_accessed_details_with_entities method definition
def get_service_last_accessed_details_with_entities(
self,
*,
JobId: str,
ServiceNamespace: str,
MaxItems: int = ...,
Marker: str = ...,
) -> GetServiceLastAccessedDetailsWithEntitiesResponseTypeDef: # (1)
...# get_service_last_accessed_details_with_entities method usage example with argument unpacking
kwargs: GetServiceLastAccessedDetailsWithEntitiesRequestTypeDef = { # (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 boto3.client("iam").get_service_linked_role_deletion_status method.
boto3 documentation
# get_service_linked_role_deletion_status method definition
def get_service_linked_role_deletion_status(
self,
*,
DeletionTaskId: str,
) -> GetServiceLinkedRoleDeletionStatusResponseTypeDef: # (1)
...# get_service_linked_role_deletion_status method usage example with argument unpacking
kwargs: GetServiceLinkedRoleDeletionStatusRequestTypeDef = { # (1)
"DeletionTaskId": ...,
}
parent.get_service_linked_role_deletion_status(**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 boto3.client("iam").get_user method.
boto3 documentation
# get_user method definition
def get_user(
self,
*,
UserName: str = ...,
) -> GetUserResponseTypeDef: # (1)
...# get_user method usage example with argument unpacking
kwargs: GetUserRequestTypeDef = { # (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 boto3.client("iam").get_user_policy method.
boto3 documentation
# get_user_policy method definition
def get_user_policy(
self,
*,
UserName: str,
PolicyName: str,
) -> GetUserPolicyResponseTypeDef: # (1)
...# get_user_policy method usage example with argument unpacking
kwargs: GetUserPolicyRequestTypeDef = { # (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 boto3.client("iam").list_access_keys method.
boto3 documentation
# list_access_keys method definition
def list_access_keys(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAccessKeysResponseTypeDef: # (1)
...# list_access_keys method usage example with argument unpacking
kwargs: ListAccessKeysRequestTypeDef = { # (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 boto3.client("iam").list_account_aliases method.
boto3 documentation
# list_account_aliases method definition
def list_account_aliases(
self,
*,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAccountAliasesResponseTypeDef: # (1)
...# list_account_aliases method usage example with argument unpacking
kwargs: ListAccountAliasesRequestTypeDef = { # (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 boto3.client("iam").list_attached_group_policies method.
boto3 documentation
# list_attached_group_policies method definition
def list_attached_group_policies(
self,
*,
GroupName: str,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAttachedGroupPoliciesResponseTypeDef: # (1)
...# list_attached_group_policies method usage example with argument unpacking
kwargs: ListAttachedGroupPoliciesRequestTypeDef = { # (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 boto3.client("iam").list_attached_role_policies method.
boto3 documentation
# list_attached_role_policies method definition
def list_attached_role_policies(
self,
*,
RoleName: str,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAttachedRolePoliciesResponseTypeDef: # (1)
...# list_attached_role_policies method usage example with argument unpacking
kwargs: ListAttachedRolePoliciesRequestTypeDef = { # (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 boto3.client("iam").list_attached_user_policies method.
boto3 documentation
# list_attached_user_policies method definition
def list_attached_user_policies(
self,
*,
UserName: str,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListAttachedUserPoliciesResponseTypeDef: # (1)
...# list_attached_user_policies method usage example with argument unpacking
kwargs: ListAttachedUserPoliciesRequestTypeDef = { # (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 boto3.client("iam").list_entities_for_policy method.
boto3 documentation
# list_entities_for_policy method definition
def list_entities_for_policy(
self,
*,
PolicyArn: str,
EntityFilter: EntityTypeType = ..., # (1)
PathPrefix: str = ...,
PolicyUsageFilter: PolicyUsageTypeType = ..., # (2)
Marker: str = ...,
MaxItems: int = ...,
) -> ListEntitiesForPolicyResponseTypeDef: # (3)
...# list_entities_for_policy method usage example with argument unpacking
kwargs: ListEntitiesForPolicyRequestTypeDef = { # (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 boto3.client("iam").list_group_policies method.
boto3 documentation
# list_group_policies method definition
def list_group_policies(
self,
*,
GroupName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListGroupPoliciesResponseTypeDef: # (1)
...# list_group_policies method usage example with argument unpacking
kwargs: ListGroupPoliciesRequestTypeDef = { # (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 boto3.client("iam").list_groups method.
boto3 documentation
# list_groups method definition
def list_groups(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListGroupsResponseTypeDef: # (1)
...# list_groups method usage example with argument unpacking
kwargs: ListGroupsRequestTypeDef = { # (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 boto3.client("iam").list_groups_for_user method.
boto3 documentation
# list_groups_for_user method definition
def list_groups_for_user(
self,
*,
UserName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListGroupsForUserResponseTypeDef: # (1)
...# list_groups_for_user method usage example with argument unpacking
kwargs: ListGroupsForUserRequestTypeDef = { # (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 boto3.client("iam").list_instance_profile_tags method.
boto3 documentation
# list_instance_profile_tags method definition
def list_instance_profile_tags(
self,
*,
InstanceProfileName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListInstanceProfileTagsResponseTypeDef: # (1)
...# list_instance_profile_tags method usage example with argument unpacking
kwargs: ListInstanceProfileTagsRequestTypeDef = { # (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 boto3.client("iam").list_instance_profiles method.
boto3 documentation
# list_instance_profiles method definition
def list_instance_profiles(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListInstanceProfilesResponseTypeDef: # (1)
...# list_instance_profiles method usage example with argument unpacking
kwargs: ListInstanceProfilesRequestTypeDef = { # (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 boto3.client("iam").list_instance_profiles_for_role method.
boto3 documentation
# list_instance_profiles_for_role method definition
def list_instance_profiles_for_role(
self,
*,
RoleName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListInstanceProfilesForRoleResponseTypeDef: # (1)
...# list_instance_profiles_for_role method usage example with argument unpacking
kwargs: ListInstanceProfilesForRoleRequestTypeDef = { # (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 boto3.client("iam").list_mfa_device_tags method.
boto3 documentation
# list_mfa_device_tags method definition
def list_mfa_device_tags(
self,
*,
SerialNumber: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListMFADeviceTagsResponseTypeDef: # (1)
...# list_mfa_device_tags method usage example with argument unpacking
kwargs: ListMFADeviceTagsRequestTypeDef = { # (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 boto3.client("iam").list_mfa_devices method.
boto3 documentation
# list_mfa_devices method definition
def list_mfa_devices(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListMFADevicesResponseTypeDef: # (1)
...# list_mfa_devices method usage example with argument unpacking
kwargs: ListMFADevicesRequestTypeDef = { # (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 boto3.client("iam").list_open_id_connect_provider_tags method.
boto3 documentation
# list_open_id_connect_provider_tags method definition
def list_open_id_connect_provider_tags(
self,
*,
OpenIDConnectProviderArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListOpenIDConnectProviderTagsResponseTypeDef: # (1)
...# list_open_id_connect_provider_tags method usage example with argument unpacking
kwargs: ListOpenIDConnectProviderTagsRequestTypeDef = { # (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 boto3.client("iam").list_open_id_connect_providers method.
boto3 documentation
# list_open_id_connect_providers method definition
def list_open_id_connect_providers(
self,
) -> ListOpenIDConnectProvidersResponseTypeDef: # (1)
...list_organizations_features#
Lists the centralized root access features enabled for your organization.
Type annotations and code completion for boto3.client("iam").list_organizations_features method.
boto3 documentation
# list_organizations_features method definition
def list_organizations_features(
self,
) -> ListOrganizationsFeaturesResponseTypeDef: # (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 boto3.client("iam").list_policies method.
boto3 documentation
# list_policies method definition
def list_policies(
self,
*,
Scope: PolicyScopeTypeType = ..., # (1)
OnlyAttached: bool = ...,
PathPrefix: str = ...,
PolicyUsageFilter: PolicyUsageTypeType = ..., # (2)
Marker: str = ...,
MaxItems: int = ...,
) -> ListPoliciesResponseTypeDef: # (3)
...# list_policies method usage example with argument unpacking
kwargs: ListPoliciesRequestTypeDef = { # (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 boto3.client("iam").list_policies_granting_service_access method.
boto3 documentation
# list_policies_granting_service_access method definition
def list_policies_granting_service_access(
self,
*,
Arn: str,
ServiceNamespaces: Sequence[str],
Marker: str = ...,
) -> ListPoliciesGrantingServiceAccessResponseTypeDef: # (1)
...# list_policies_granting_service_access method usage example with argument unpacking
kwargs: ListPoliciesGrantingServiceAccessRequestTypeDef = { # (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 boto3.client("iam").list_policy_tags method.
boto3 documentation
# list_policy_tags method definition
def list_policy_tags(
self,
*,
PolicyArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListPolicyTagsResponseTypeDef: # (1)
...# list_policy_tags method usage example with argument unpacking
kwargs: ListPolicyTagsRequestTypeDef = { # (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 boto3.client("iam").list_policy_versions method.
boto3 documentation
# list_policy_versions method definition
def list_policy_versions(
self,
*,
PolicyArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListPolicyVersionsResponseTypeDef: # (1)
...# list_policy_versions method usage example with argument unpacking
kwargs: ListPolicyVersionsRequestTypeDef = { # (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 boto3.client("iam").list_role_policies method.
boto3 documentation
# list_role_policies method definition
def list_role_policies(
self,
*,
RoleName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListRolePoliciesResponseTypeDef: # (1)
...# list_role_policies method usage example with argument unpacking
kwargs: ListRolePoliciesRequestTypeDef = { # (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 boto3.client("iam").list_role_tags method.
boto3 documentation
# list_role_tags method definition
def list_role_tags(
self,
*,
RoleName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListRoleTagsResponseTypeDef: # (1)
...# list_role_tags method usage example with argument unpacking
kwargs: ListRoleTagsRequestTypeDef = { # (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 boto3.client("iam").list_roles method.
boto3 documentation
# list_roles method definition
def list_roles(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListRolesResponseTypeDef: # (1)
...# list_roles method usage example with argument unpacking
kwargs: ListRolesRequestTypeDef = { # (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 boto3.client("iam").list_saml_provider_tags method.
boto3 documentation
# list_saml_provider_tags method definition
def list_saml_provider_tags(
self,
*,
SAMLProviderArn: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListSAMLProviderTagsResponseTypeDef: # (1)
...# list_saml_provider_tags method usage example with argument unpacking
kwargs: ListSAMLProviderTagsRequestTypeDef = { # (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 boto3.client("iam").list_saml_providers method.
boto3 documentation
# list_saml_providers method definition
def list_saml_providers(
self,
) -> ListSAMLProvidersResponseTypeDef: # (1)
...list_ssh_public_keys#
Returns information about the SSH public keys associated with the specified IAM user.
Type annotations and code completion for boto3.client("iam").list_ssh_public_keys method.
boto3 documentation
# list_ssh_public_keys method definition
def list_ssh_public_keys(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListSSHPublicKeysResponseTypeDef: # (1)
...# list_ssh_public_keys method usage example with argument unpacking
kwargs: ListSSHPublicKeysRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_ssh_public_keys(**kwargs)list_server_certificate_tags#
Lists the tags that are attached to the specified IAM server certificate.
Type annotations and code completion for boto3.client("iam").list_server_certificate_tags method.
boto3 documentation
# list_server_certificate_tags method definition
def list_server_certificate_tags(
self,
*,
ServerCertificateName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListServerCertificateTagsResponseTypeDef: # (1)
...# list_server_certificate_tags method usage example with argument unpacking
kwargs: ListServerCertificateTagsRequestTypeDef = { # (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 boto3.client("iam").list_server_certificates method.
boto3 documentation
# list_server_certificates method definition
def list_server_certificates(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListServerCertificatesResponseTypeDef: # (1)
...# list_server_certificates method usage example with argument unpacking
kwargs: ListServerCertificatesRequestTypeDef = { # (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 boto3.client("iam").list_service_specific_credentials method.
boto3 documentation
# list_service_specific_credentials method definition
def list_service_specific_credentials(
self,
*,
UserName: str = ...,
ServiceName: str = ...,
AllUsers: bool = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListServiceSpecificCredentialsResponseTypeDef: # (1)
...# list_service_specific_credentials method usage example with argument unpacking
kwargs: ListServiceSpecificCredentialsRequestTypeDef = { # (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 boto3.client("iam").list_signing_certificates method.
boto3 documentation
# list_signing_certificates method definition
def list_signing_certificates(
self,
*,
UserName: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListSigningCertificatesResponseTypeDef: # (1)
...# list_signing_certificates method usage example with argument unpacking
kwargs: ListSigningCertificatesRequestTypeDef = { # (1)
"UserName": ...,
}
parent.list_signing_certificates(**kwargs)list_user_policies#
Lists the names of the inline policies embedded in the specified IAM user.
Type annotations and code completion for boto3.client("iam").list_user_policies method.
boto3 documentation
# list_user_policies method definition
def list_user_policies(
self,
*,
UserName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListUserPoliciesResponseTypeDef: # (1)
...# list_user_policies method usage example with argument unpacking
kwargs: ListUserPoliciesRequestTypeDef = { # (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 boto3.client("iam").list_user_tags method.
boto3 documentation
# list_user_tags method definition
def list_user_tags(
self,
*,
UserName: str,
Marker: str = ...,
MaxItems: int = ...,
) -> ListUserTagsResponseTypeDef: # (1)
...# list_user_tags method usage example with argument unpacking
kwargs: ListUserTagsRequestTypeDef = { # (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 boto3.client("iam").list_users method.
boto3 documentation
# list_users method definition
def list_users(
self,
*,
PathPrefix: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListUsersResponseTypeDef: # (1)
...# list_users method usage example with argument unpacking
kwargs: ListUsersRequestTypeDef = { # (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 boto3.client("iam").list_virtual_mfa_devices method.
boto3 documentation
# list_virtual_mfa_devices method definition
def list_virtual_mfa_devices(
self,
*,
AssignmentStatus: AssignmentStatusTypeType = ..., # (1)
Marker: str = ...,
MaxItems: int = ...,
) -> ListVirtualMFADevicesResponseTypeDef: # (2)
...# list_virtual_mfa_devices method usage example with argument unpacking
kwargs: ListVirtualMFADevicesRequestTypeDef = { # (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 boto3.client("iam").put_group_policy method.
boto3 documentation
# put_group_policy method definition
def put_group_policy(
self,
*,
GroupName: str,
PolicyName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_group_policy method usage example with argument unpacking
kwargs: PutGroupPolicyRequestTypeDef = { # (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 boto3.client("iam").put_role_permissions_boundary method.
boto3 documentation
# put_role_permissions_boundary method definition
def put_role_permissions_boundary(
self,
*,
RoleName: str,
PermissionsBoundary: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_role_permissions_boundary method usage example with argument unpacking
kwargs: PutRolePermissionsBoundaryRequestTypeDef = { # (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 boto3.client("iam").put_role_policy method.
boto3 documentation
# put_role_policy method definition
def put_role_policy(
self,
*,
RoleName: str,
PolicyName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_role_policy method usage example with argument unpacking
kwargs: PutRolePolicyRequestTypeDef = { # (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 boto3.client("iam").put_user_permissions_boundary method.
boto3 documentation
# put_user_permissions_boundary method definition
def put_user_permissions_boundary(
self,
*,
UserName: str,
PermissionsBoundary: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_user_permissions_boundary method usage example with argument unpacking
kwargs: PutUserPermissionsBoundaryRequestTypeDef = { # (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 boto3.client("iam").put_user_policy method.
boto3 documentation
# put_user_policy method definition
def put_user_policy(
self,
*,
UserName: str,
PolicyName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_user_policy method usage example with argument unpacking
kwargs: PutUserPolicyRequestTypeDef = { # (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 boto3.client("iam").remove_client_id_from_open_id_connect_provider method.
boto3 documentation
# remove_client_id_from_open_id_connect_provider method definition
def remove_client_id_from_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
ClientID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# remove_client_id_from_open_id_connect_provider method usage example with argument unpacking
kwargs: RemoveClientIDFromOpenIDConnectProviderRequestTypeDef = { # (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 Amazon EC2 instance profile.
Type annotations and code completion for boto3.client("iam").remove_role_from_instance_profile method.
boto3 documentation
# remove_role_from_instance_profile method definition
def remove_role_from_instance_profile(
self,
*,
InstanceProfileName: str,
RoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# remove_role_from_instance_profile method usage example with argument unpacking
kwargs: RemoveRoleFromInstanceProfileRequestTypeDef = { # (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 boto3.client("iam").remove_user_from_group method.
boto3 documentation
# remove_user_from_group method definition
def remove_user_from_group(
self,
*,
GroupName: str,
UserName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# remove_user_from_group method usage example with argument unpacking
kwargs: RemoveUserFromGroupRequestTypeDef = { # (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 boto3.client("iam").reset_service_specific_credential method.
boto3 documentation
# reset_service_specific_credential method definition
def reset_service_specific_credential(
self,
*,
ServiceSpecificCredentialId: str,
UserName: str = ...,
) -> ResetServiceSpecificCredentialResponseTypeDef: # (1)
...# reset_service_specific_credential method usage example with argument unpacking
kwargs: ResetServiceSpecificCredentialRequestTypeDef = { # (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 boto3.client("iam").resync_mfa_device method.
boto3 documentation
# resync_mfa_device method definition
def resync_mfa_device(
self,
*,
UserName: str,
SerialNumber: str,
AuthenticationCode1: str,
AuthenticationCode2: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# resync_mfa_device method usage example with argument unpacking
kwargs: ResyncMFADeviceRequestTypeDef = { # (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 boto3.client("iam").set_default_policy_version method.
boto3 documentation
# set_default_policy_version method definition
def set_default_policy_version(
self,
*,
PolicyArn: str,
VersionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# set_default_policy_version method usage example with argument unpacking
kwargs: SetDefaultPolicyVersionRequestTypeDef = { # (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 boto3.client("iam").set_security_token_service_preferences method.
boto3 documentation
# set_security_token_service_preferences method definition
def set_security_token_service_preferences(
self,
*,
GlobalEndpointTokenVersion: GlobalEndpointTokenVersionType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# set_security_token_service_preferences method usage example with argument unpacking
kwargs: SetSecurityTokenServicePreferencesRequestTypeDef = { # (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 boto3.client("iam").simulate_custom_policy method.
boto3 documentation
# simulate_custom_policy method definition
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)
...- See
Sequence[ContextEntryTypeDef] - See SimulatePolicyResponseTypeDef
# simulate_custom_policy method usage example with argument unpacking
kwargs: SimulateCustomPolicyRequestTypeDef = { # (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 boto3.client("iam").simulate_principal_policy method.
boto3 documentation
# simulate_principal_policy method definition
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)
...- See
Sequence[ContextEntryTypeDef] - See SimulatePolicyResponseTypeDef
# simulate_principal_policy method usage example with argument unpacking
kwargs: SimulatePrincipalPolicyRequestTypeDef = { # (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 boto3.client("iam").tag_instance_profile method.
boto3 documentation
# tag_instance_profile method definition
def tag_instance_profile(
self,
*,
InstanceProfileName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_instance_profile method usage example with argument unpacking
kwargs: TagInstanceProfileRequestTypeDef = { # (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 boto3.client("iam").tag_mfa_device method.
boto3 documentation
# tag_mfa_device method definition
def tag_mfa_device(
self,
*,
SerialNumber: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_mfa_device method usage example with argument unpacking
kwargs: TagMFADeviceRequestTypeDef = { # (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 boto3.client("iam").tag_open_id_connect_provider method.
boto3 documentation
# tag_open_id_connect_provider method definition
def tag_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_open_id_connect_provider method usage example with argument unpacking
kwargs: TagOpenIDConnectProviderRequestTypeDef = { # (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 boto3.client("iam").tag_policy method.
boto3 documentation
# tag_policy method definition
def tag_policy(
self,
*,
PolicyArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_policy method usage example with argument unpacking
kwargs: TagPolicyRequestTypeDef = { # (1)
"PolicyArn": ...,
"Tags": ...,
}
parent.tag_policy(**kwargs)tag_role#
Adds one or more tags to an IAM role.
Type annotations and code completion for boto3.client("iam").tag_role method.
boto3 documentation
# tag_role method definition
def tag_role(
self,
*,
RoleName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_role method usage example with argument unpacking
kwargs: TagRoleRequestTypeDef = { # (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 boto3.client("iam").tag_saml_provider method.
boto3 documentation
# tag_saml_provider method definition
def tag_saml_provider(
self,
*,
SAMLProviderArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_saml_provider method usage example with argument unpacking
kwargs: TagSAMLProviderRequestTypeDef = { # (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 boto3.client("iam").tag_server_certificate method.
boto3 documentation
# tag_server_certificate method definition
def tag_server_certificate(
self,
*,
ServerCertificateName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_server_certificate method usage example with argument unpacking
kwargs: TagServerCertificateRequestTypeDef = { # (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 boto3.client("iam").tag_user method.
boto3 documentation
# tag_user method definition
def tag_user(
self,
*,
UserName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# tag_user method usage example with argument unpacking
kwargs: TagUserRequestTypeDef = { # (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 boto3.client("iam").untag_instance_profile method.
boto3 documentation
# untag_instance_profile method definition
def untag_instance_profile(
self,
*,
InstanceProfileName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_instance_profile method usage example with argument unpacking
kwargs: UntagInstanceProfileRequestTypeDef = { # (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 boto3.client("iam").untag_mfa_device method.
boto3 documentation
# untag_mfa_device method definition
def untag_mfa_device(
self,
*,
SerialNumber: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_mfa_device method usage example with argument unpacking
kwargs: UntagMFADeviceRequestTypeDef = { # (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 boto3.client("iam").untag_open_id_connect_provider method.
boto3 documentation
# untag_open_id_connect_provider method definition
def untag_open_id_connect_provider(
self,
*,
OpenIDConnectProviderArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_open_id_connect_provider method usage example with argument unpacking
kwargs: UntagOpenIDConnectProviderRequestTypeDef = { # (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 boto3.client("iam").untag_policy method.
boto3 documentation
# untag_policy method definition
def untag_policy(
self,
*,
PolicyArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_policy method usage example with argument unpacking
kwargs: UntagPolicyRequestTypeDef = { # (1)
"PolicyArn": ...,
"TagKeys": ...,
}
parent.untag_policy(**kwargs)untag_role#
Removes the specified tags from the role.
Type annotations and code completion for boto3.client("iam").untag_role method.
boto3 documentation
# untag_role method definition
def untag_role(
self,
*,
RoleName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_role method usage example with argument unpacking
kwargs: UntagRoleRequestTypeDef = { # (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 boto3.client("iam").untag_saml_provider method.
boto3 documentation
# untag_saml_provider method definition
def untag_saml_provider(
self,
*,
SAMLProviderArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_saml_provider method usage example with argument unpacking
kwargs: UntagSAMLProviderRequestTypeDef = { # (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 boto3.client("iam").untag_server_certificate method.
boto3 documentation
# untag_server_certificate method definition
def untag_server_certificate(
self,
*,
ServerCertificateName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_server_certificate method usage example with argument unpacking
kwargs: UntagServerCertificateRequestTypeDef = { # (1)
"ServerCertificateName": ...,
"TagKeys": ...,
}
parent.untag_server_certificate(**kwargs)untag_user#
Removes the specified tags from the user.
Type annotations and code completion for boto3.client("iam").untag_user method.
boto3 documentation
# untag_user method definition
def untag_user(
self,
*,
UserName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_user method usage example with argument unpacking
kwargs: UntagUserRequestTypeDef = { # (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 boto3.client("iam").update_access_key method.
boto3 documentation
# update_access_key method definition
def update_access_key(
self,
*,
AccessKeyId: str,
Status: StatusTypeType, # (1)
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_access_key method usage example with argument unpacking
kwargs: UpdateAccessKeyRequestTypeDef = { # (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 boto3.client("iam").update_account_password_policy method.
boto3 documentation
# update_account_password_policy method definition
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)
...# update_account_password_policy method usage example with argument unpacking
kwargs: UpdateAccountPasswordPolicyRequestTypeDef = { # (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 boto3.client("iam").update_assume_role_policy method.
boto3 documentation
# update_assume_role_policy method definition
def update_assume_role_policy(
self,
*,
RoleName: str,
PolicyDocument: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_assume_role_policy method usage example with argument unpacking
kwargs: UpdateAssumeRolePolicyRequestTypeDef = { # (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 boto3.client("iam").update_group method.
boto3 documentation
# update_group method definition
def update_group(
self,
*,
GroupName: str,
NewPath: str = ...,
NewGroupName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_group method usage example with argument unpacking
kwargs: UpdateGroupRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.update_group(**kwargs)update_login_profile#
Changes the password for the specified IAM user.
Type annotations and code completion for boto3.client("iam").update_login_profile method.
boto3 documentation
# update_login_profile method definition
def update_login_profile(
self,
*,
UserName: str,
Password: str = ...,
PasswordResetRequired: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_login_profile method usage example with argument unpacking
kwargs: UpdateLoginProfileRequestTypeDef = { # (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 boto3.client("iam").update_open_id_connect_provider_thumbprint method.
boto3 documentation
# update_open_id_connect_provider_thumbprint method definition
def update_open_id_connect_provider_thumbprint(
self,
*,
OpenIDConnectProviderArn: str,
ThumbprintList: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_open_id_connect_provider_thumbprint method usage example with argument unpacking
kwargs: UpdateOpenIDConnectProviderThumbprintRequestTypeDef = { # (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 boto3.client("iam").update_role method.
boto3 documentation
# update_role method definition
def update_role(
self,
*,
RoleName: str,
Description: str = ...,
MaxSessionDuration: int = ...,
) -> Dict[str, Any]:
...# update_role method usage example with argument unpacking
kwargs: UpdateRoleRequestTypeDef = { # (1)
"RoleName": ...,
}
parent.update_role(**kwargs)update_role_description#
Use UpdateRole instead.
Type annotations and code completion for boto3.client("iam").update_role_description method.
boto3 documentation
# update_role_description method definition
def update_role_description(
self,
*,
RoleName: str,
Description: str,
) -> UpdateRoleDescriptionResponseTypeDef: # (1)
...# update_role_description method usage example with argument unpacking
kwargs: UpdateRoleDescriptionRequestTypeDef = { # (1)
"RoleName": ...,
"Description": ...,
}
parent.update_role_description(**kwargs)update_saml_provider#
Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider.
Type annotations and code completion for boto3.client("iam").update_saml_provider method.
boto3 documentation
# update_saml_provider method definition
def update_saml_provider(
self,
*,
SAMLProviderArn: str,
SAMLMetadataDocument: str = ...,
AssertionEncryptionMode: AssertionEncryptionModeTypeType = ..., # (1)
AddPrivateKey: str = ...,
RemovePrivateKey: str = ...,
) -> UpdateSAMLProviderResponseTypeDef: # (2)
...# update_saml_provider method usage example with argument unpacking
kwargs: UpdateSAMLProviderRequestTypeDef = { # (1)
"SAMLProviderArn": ...,
}
parent.update_saml_provider(**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 boto3.client("iam").update_ssh_public_key method.
boto3 documentation
# update_ssh_public_key method definition
def update_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyId: str,
Status: StatusTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_ssh_public_key method usage example with argument unpacking
kwargs: UpdateSSHPublicKeyRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyId": ...,
"Status": ...,
}
parent.update_ssh_public_key(**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 boto3.client("iam").update_server_certificate method.
boto3 documentation
# update_server_certificate method definition
def update_server_certificate(
self,
*,
ServerCertificateName: str,
NewPath: str = ...,
NewServerCertificateName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_server_certificate method usage example with argument unpacking
kwargs: UpdateServerCertificateRequestTypeDef = { # (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 boto3.client("iam").update_service_specific_credential method.
boto3 documentation
# update_service_specific_credential method definition
def update_service_specific_credential(
self,
*,
ServiceSpecificCredentialId: str,
Status: StatusTypeType, # (1)
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_service_specific_credential method usage example with argument unpacking
kwargs: UpdateServiceSpecificCredentialRequestTypeDef = { # (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 boto3.client("iam").update_signing_certificate method.
boto3 documentation
# update_signing_certificate method definition
def update_signing_certificate(
self,
*,
CertificateId: str,
Status: StatusTypeType, # (1)
UserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_signing_certificate method usage example with argument unpacking
kwargs: UpdateSigningCertificateRequestTypeDef = { # (1)
"CertificateId": ...,
"Status": ...,
}
parent.update_signing_certificate(**kwargs)update_user#
Updates the name and/or the path of the specified IAM user.
Type annotations and code completion for boto3.client("iam").update_user method.
boto3 documentation
# update_user method definition
def update_user(
self,
*,
UserName: str,
NewPath: str = ...,
NewUserName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_user method usage example with argument unpacking
kwargs: UpdateUserRequestTypeDef = { # (1)
"UserName": ...,
}
parent.update_user(**kwargs)upload_ssh_public_key#
Uploads an SSH public key and associates it with the specified IAM user.
Type annotations and code completion for boto3.client("iam").upload_ssh_public_key method.
boto3 documentation
# upload_ssh_public_key method definition
def upload_ssh_public_key(
self,
*,
UserName: str,
SSHPublicKeyBody: str,
) -> UploadSSHPublicKeyResponseTypeDef: # (1)
...# upload_ssh_public_key method usage example with argument unpacking
kwargs: UploadSSHPublicKeyRequestTypeDef = { # (1)
"UserName": ...,
"SSHPublicKeyBody": ...,
}
parent.upload_ssh_public_key(**kwargs)upload_server_certificate#
Uploads a server certificate entity for the Amazon Web Services account.
Type annotations and code completion for boto3.client("iam").upload_server_certificate method.
boto3 documentation
# upload_server_certificate method definition
def upload_server_certificate(
self,
*,
ServerCertificateName: str,
CertificateBody: str,
PrivateKey: str,
Path: str = ...,
CertificateChain: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> UploadServerCertificateResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See UploadServerCertificateResponseTypeDef
# upload_server_certificate method usage example with argument unpacking
kwargs: UploadServerCertificateRequestTypeDef = { # (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 boto3.client("iam").upload_signing_certificate method.
boto3 documentation
# upload_signing_certificate method definition
def upload_signing_certificate(
self,
*,
CertificateBody: str,
UserName: str = ...,
) -> UploadSigningCertificateResponseTypeDef: # (1)
...# upload_signing_certificate method usage example with argument unpacking
kwargs: UploadSigningCertificateRequestTypeDef = { # (1)
"CertificateBody": ...,
}
parent.upload_signing_certificate(**kwargs)get_paginator#
Type annotations and code completion for boto3.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_for_user")-> ListGroupsForUserPaginatorclient.get_paginator("list_groups")-> ListGroupsPaginatorclient.get_paginator("list_instance_profile_tags")-> ListInstanceProfileTagsPaginatorclient.get_paginator("list_instance_profiles_for_role")-> ListInstanceProfilesForRolePaginatorclient.get_paginator("list_instance_profiles")-> ListInstanceProfilesPaginatorclient.get_paginator("list_mfa_device_tags")-> ListMFADeviceTagsPaginatorclient.get_paginator("list_mfa_devices")-> ListMFADevicesPaginatorclient.get_paginator("list_open_id_connect_provider_tags")-> ListOpenIDConnectProviderTagsPaginatorclient.get_paginator("list_policies")-> ListPoliciesPaginatorclient.get_paginator("list_policy_tags")-> ListPolicyTagsPaginatorclient.get_paginator("list_policy_versions")-> ListPolicyVersionsPaginatorclient.get_paginator("list_role_policies")-> ListRolePoliciesPaginatorclient.get_paginator("list_role_tags")-> ListRoleTagsPaginatorclient.get_paginator("list_roles")-> ListRolesPaginatorclient.get_paginator("list_saml_provider_tags")-> ListSAMLProviderTagsPaginatorclient.get_paginator("list_ssh_public_keys")-> ListSSHPublicKeysPaginatorclient.get_paginator("list_server_certificate_tags")-> ListServerCertificateTagsPaginatorclient.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 boto3.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