JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.identitymanagement

Class AmazonIdentityManagementClient

    • Constructor Detail

      • AmazonIdentityManagementClient

        @Deprecated
public AmazonIdentityManagementClient()
        Constructs a new client to invoke service methods on IAM. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain

      • AmazonIdentityManagementClient

        @Deprecated
public AmazonIdentityManagementClient(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on IAM. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to IAM (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain

      • AmazonIdentityManagementClient

        @Deprecated
public AmazonIdentityManagementClient(AWSCredentials awsCredentials)
        Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonIdentityManagementClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
        Constructs a new client to invoke service methods on IAM using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

      • AmazonIdentityManagementClient

        @Deprecated
public AmazonIdentityManagementClient(AWSCredentials awsCredentials,
 ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on IAM using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to IAM (ex: proxy settings, retry counts, etc.).

      • AmazonIdentityManagementClient

        @Deprecated
public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on IAM using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

      • AmazonIdentityManagementClient

        @Deprecated
public AmazonIdentityManagementClient(AWSCredentialsProvider awsCredentialsProvider,
 ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on IAM using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to IAM (ex: proxy settings, retry counts, etc.).

    • Method Detail

      • addClientIDToOpenIDConnectProvider

        public AddClientIDToOpenIDConnectProviderResult addClientIDToOpenIDConnectProvider(AddClientIDToOpenIDConnectProviderRequest request)

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

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

        Specified by:
        addClientIDToOpenIDConnectProvider in interface AmazonIdentityManagement
        Parameters:
        addClientIDToOpenIDConnectProviderRequest -
        Returns:
        Result of the AddClientIDToOpenIDConnectProvider operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To add a client ID (audience) to an Open-ID Connect (OIDC) provider
          The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
AddClientIDToOpenIDConnectProviderRequest request = new AddClientIDToOpenIDConnectProviderRequest().withOpenIDConnectProviderArn(
 "arn:aws:iam::123456789012:oidc-provider/server.example.com").withClientID("my-application-ID");
AddClientIDToOpenIDConnectProviderResult response = client.addClientIDToOpenIDConnectProvider(request);

      • addRoleToInstanceProfile

        public AddRoleToInstanceProfileResult addRoleToInstanceProfile(AddRoleToInstanceProfileRequest request)

        Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

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

        For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

        Specified by:
        addRoleToInstanceProfile in interface AmazonIdentityManagement
        Parameters:
        addRoleToInstanceProfileRequest -
        Returns:
        Result of the AddRoleToInstanceProfile operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To add a role to an instance profile
          The following command adds the role named S3Access to the instance profile named Webserver:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
AddRoleToInstanceProfileRequest request = new AddRoleToInstanceProfileRequest().withInstanceProfileName("Webserver").withRoleName("S3Access");
AddRoleToInstanceProfileResult response = client.addRoleToInstanceProfile(request);

      • addUserToGroup

        public AddUserToGroupResult addUserToGroup(AddUserToGroupRequest request)

        Adds the specified user to the specified group.

        Specified by:
        addUserToGroup in interface AmazonIdentityManagement
        Parameters:
        addUserToGroupRequest -
        Returns:
        Result of the AddUserToGroup operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To add a user to an IAM group
          The following command adds an IAM user named Bob to the IAM group named Admins:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
AddUserToGroupRequest request = new AddUserToGroupRequest().withGroupName("Admins").withUserName("Bob");
AddUserToGroupResult response = client.addUserToGroup(request);

      • attachGroupPolicy

        public AttachGroupPolicyResult attachGroupPolicy(AttachGroupPolicyRequest request)

        Attaches the specified managed policy to the specified IAM group.

        You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy .

        As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

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

        Specified by:
        attachGroupPolicy in interface AmazonIdentityManagement
        Parameters:
        attachGroupPolicyRequest -
        Returns:
        Result of the AttachGroupPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        PolicyNotAttachableException - The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To attach a managed policy to an IAM group
          The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
AttachGroupPolicyRequest request = new AttachGroupPolicyRequest().withGroupName("Finance").withPolicyArn("arn:aws:iam::aws:policy/ReadOnlyAccess");
AttachGroupPolicyResult response = client.attachGroupPolicy(request);

      • attachRolePolicy

        public AttachRolePolicyResult attachRolePolicy(AttachRolePolicyRequest request)

        Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

        You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumerolePolicy .

        Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy . For more information about policies, see Managed policies and inline policies in the IAM User Guide.

        As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

        Specified by:
        attachRolePolicy in interface AmazonIdentityManagement
        Parameters:
        attachRolePolicyRequest -
        Returns:
        Result of the AttachRolePolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        PolicyNotAttachableException - The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To attach a managed policy to an IAM role
          The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
AttachRolePolicyRequest request = new AttachRolePolicyRequest().withRoleName("ReadOnlyRole").withPolicyArn("arn:aws:iam::aws:policy/ReadOnlyAccess");
AttachRolePolicyResult response = client.attachRolePolicy(request);

      • attachUserPolicy

        public AttachUserPolicyResult attachUserPolicy(AttachUserPolicyRequest request)

        Attaches the specified managed policy to the specified user.

        You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy .

        As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

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

        Specified by:
        attachUserPolicy in interface AmazonIdentityManagement
        Parameters:
        attachUserPolicyRequest -
        Returns:
        Result of the AttachUserPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        PolicyNotAttachableException - The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To attach a managed policy to an IAM user
          The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
AttachUserPolicyRequest request = new AttachUserPolicyRequest().withUserName("Alice").withPolicyArn("arn:aws:iam::aws:policy/AdministratorAccess");
AttachUserPolicyResult response = client.attachUserPolicy(request);

      • changePassword

        public ChangePasswordResult changePassword(ChangePasswordRequest request)

        Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.

        Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.

        Specified by:
        changePassword in interface AmazonIdentityManagement
        Parameters:
        changePasswordRequest -
        Returns:
        Result of the ChangePassword operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidUserTypeException - The request was rejected because the type of user for the transaction was incorrect.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        EntityTemporarilyUnmodifiableException - The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
        PasswordPolicyViolationException - The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To change the password for your IAM user
          The following command changes the password for the current IAM user.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ChangePasswordRequest request = new ChangePasswordRequest().withOldPassword("3s0K_;xh4~8XXI").withNewPassword("]35d/{pB9Fo9wJ");
ChangePasswordResult response = client.changePassword(request);

      • createAccessKey

        public CreateAccessKeyResult createAccessKey(CreateAccessKeyRequest request)

        Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active.

        If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.

        For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.

        To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

        Specified by:
        createAccessKey in interface AmazonIdentityManagement
        Parameters:
        createAccessKeyRequest -
        Returns:
        Result of the CreateAccessKey operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an access key for an IAM user
          The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateAccessKeyRequest request = new CreateAccessKeyRequest().withUserName("Bob");
CreateAccessKeyResult response = client.createAccessKey(request);

      • createAccountAlias

        public CreateAccountAliasResult createAccountAlias(CreateAccountAliasRequest request)

        Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

        Specified by:
        createAccountAlias in interface AmazonIdentityManagement
        Parameters:
        createAccountAliasRequest -
        Returns:
        Result of the CreateAccountAlias operation returned by the service.
        Throws:
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an account alias
          The following command associates the alias examplecorp to your AWS account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateAccountAliasRequest request = new CreateAccountAliasRequest().withAccountAlias("examplecorp");
CreateAccountAliasResult response = client.createAccountAlias(request);

      • createGroup

        public CreateGroupResult createGroup(CreateGroupRequest request)

        Creates a new group.

        For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.

        Specified by:
        createGroup in interface AmazonIdentityManagement
        Parameters:
        createGroupRequest -
        Returns:
        Result of the CreateGroup operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an IAM group
          The following command creates an IAM group named Admins.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateGroupRequest request = new CreateGroupRequest().withGroupName("Admins");
CreateGroupResult response = client.createGroup(request);

      • createInstanceProfile

        public CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest request)

        Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.

        For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.

        Specified by:
        createInstanceProfile in interface AmazonIdentityManagement
        Parameters:
        createInstanceProfileRequest -
        Returns:
        Result of the CreateInstanceProfile operation returned by the service.
        Throws:
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an instance profile
          The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateInstanceProfileRequest request = new CreateInstanceProfileRequest().withInstanceProfileName("Webserver");
CreateInstanceProfileResult response = client.createInstanceProfile(request);

      • createLoginProfile

        public CreateLoginProfileResult createLoginProfile(CreateLoginProfileRequest request)

        Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.

        You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.

        For more information about managing passwords, see Managing passwords in the IAM User Guide.

        Specified by:
        createLoginProfile in interface AmazonIdentityManagement
        Parameters:
        createLoginProfileRequest -
        Returns:
        Result of the CreateLoginProfile operation returned by the service.
        Throws:
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        PasswordPolicyViolationException - The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an instance profile
          The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateLoginProfileRequest request = new CreateLoginProfileRequest().withUserName("Bob").withPassword("h]6EszR}vJ*m").withPasswordResetRequired(true);
CreateLoginProfileResult response = client.createLoginProfile(request);

      • createOpenIDConnectProvider

        public CreateOpenIDConnectProviderResult createOpenIDConnectProvider(CreateOpenIDConnectProviderRequest request)

        Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

        The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.

        If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.

        When you create the IAM OIDC provider, you specify the following:

        • The URL of the OIDC identity provider (IdP) to trust

        • A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider

        • A list of tags that are attached to the specified IAM OIDC provider

        • A list of thumbprints of one or more server certificates that the IdP uses

        You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.

        Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub, GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint.

        The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.

        Specified by:
        createOpenIDConnectProvider in interface AmazonIdentityManagement
        Parameters:
        createOpenIDConnectProviderRequest -
        Returns:
        Result of the CreateOpenIDConnectProvider operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        OpenIdIdpCommunicationErrorException - The request failed because IAM cannot connect to the OpenID Connect identity provider URL.
        See Also:
        AWS API Documentation

        Samples:
        • To create an instance profile
          The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateOpenIDConnectProviderRequest request = new CreateOpenIDConnectProviderRequest().withUrl("https://server.example.com")
 .withClientIDList("my-application-id").withThumbprintList("3768084dfb3d2b68b7897bf5f565da8efEXAMPLE");
CreateOpenIDConnectProviderResult response = client.createOpenIDConnectProvider(request);

      • createPolicy

        public CreatePolicyResult createPolicy(CreatePolicyRequest request)

        Creates a new managed policy for your Amazon Web Services account.

        This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

        As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

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

        Specified by:
        createPolicy in interface AmazonIdentityManagement
        Parameters:
        createPolicyRequest -
        Returns:
        Result of the CreatePolicy operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • createPolicyVersion

        public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)

        Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

        Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

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

        Specified by:
        createPolicyVersion in interface AmazonIdentityManagement
        Parameters:
        createPolicyVersionRequest -
        Returns:
        Result of the CreatePolicyVersion operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • createRole

        public CreateRoleResult createRole(CreateRoleRequest request)

        Creates a new role for your Amazon Web Services account.

        For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide.

        Specified by:
        createRole in interface AmazonIdentityManagement
        Parameters:
        createRoleRequest -
        Returns:
        Result of the CreateRole operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an IAM role
          The following command creates a role named Test-Role and attaches a trust policy to it that is provided as a URL-encoded JSON string.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateRoleRequest request = new CreateRoleRequest().withPath("/").withRoleName("Test-Role").withAssumeRolePolicyDocument("");
CreateRoleResult response = client.createRole(request);

      • createSAMLProvider

        public CreateSAMLProviderResult createSAMLProvider(CreateSAMLProviderRequest request)

        Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

        The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.

        When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

        This operation requires Signature Version 4.

        For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.

        Specified by:
        createSAMLProvider in interface AmazonIdentityManagement
        Parameters:
        createSAMLProviderRequest -
        Returns:
        Result of the CreateSAMLProvider operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • createServiceLinkedRole

        public CreateServiceLinkedRoleResult createServiceLinkedRole(CreateServiceLinkedRoleRequest request)

        Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide.

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

        Specified by:
        createServiceLinkedRole in interface AmazonIdentityManagement
        Parameters:
        createServiceLinkedRoleRequest -
        Returns:
        Result of the CreateServiceLinkedRole operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • createUser

        public CreateUserResult createUser(CreateUserRequest request)

        Creates a new IAM user for your Amazon Web Services account.

        For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.

        Specified by:
        createUser in interface AmazonIdentityManagement
        Parameters:
        createUserRequest -
        Returns:
        Result of the CreateUser operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To create an IAM user
          The following create-user command creates an IAM user named Bob in the current account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
CreateUserRequest request = new CreateUserRequest().withUserName("Bob");
CreateUserResult response = client.createUser(request);

      • createVirtualMFADevice

        public CreateVirtualMFADeviceResult createVirtualMFADevice(CreateVirtualMFADeviceRequest request)

        Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

        For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.

        The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

        Specified by:
        createVirtualMFADevice in interface AmazonIdentityManagement
        Parameters:
        createVirtualMFADeviceRequest -
        Returns:
        Result of the CreateVirtualMFADevice operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deactivateMFADevice

        public DeactivateMFADeviceResult deactivateMFADevice(DeactivateMFADeviceRequest request)

        Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

        For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.

        Specified by:
        deactivateMFADevice in interface AmazonIdentityManagement
        Parameters:
        deactivateMFADeviceRequest -
        Returns:
        Result of the DeactivateMFADevice operation returned by the service.
        Throws:
        EntityTemporarilyUnmodifiableException - The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        See Also:
        AWS API Documentation

      • deleteAccessKey

        public DeleteAccessKeyResult deleteAccessKey(DeleteAccessKeyRequest request)

        Deletes the access key pair associated with the specified IAM user.

        If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

        Specified by:
        deleteAccessKey in interface AmazonIdentityManagement
        Parameters:
        deleteAccessKeyRequest -
        Returns:
        Result of the DeleteAccessKey operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete an access key for an IAM user
          The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteAccessKeyRequest request = new DeleteAccessKeyRequest().withUserName("Bob").withAccessKeyId("AKIDPMS9RO4H3FEXAMPLE");
DeleteAccessKeyResult response = client.deleteAccessKey(request);

      • deleteAccountAlias

        public DeleteAccountAliasResult deleteAccountAlias(DeleteAccountAliasRequest request)

        Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

        Specified by:
        deleteAccountAlias in interface AmazonIdentityManagement
        Parameters:
        deleteAccountAliasRequest -
        Returns:
        Result of the DeleteAccountAlias operation returned by the service.
        Throws:
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete an account alias
          The following command removes the alias mycompany from the current AWS account:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteAccountAliasRequest request = new DeleteAccountAliasRequest().withAccountAlias("mycompany");
DeleteAccountAliasResult response = client.deleteAccountAlias(request);

      • deleteAccountPasswordPolicy

        public DeleteAccountPasswordPolicyResult deleteAccountPasswordPolicy(DeleteAccountPasswordPolicyRequest request)

        Deletes the password policy for the Amazon Web Services account. There are no parameters.

        Specified by:
        deleteAccountPasswordPolicy in interface AmazonIdentityManagement
        Parameters:
        deleteAccountPasswordPolicyRequest -
        Returns:
        Result of the DeleteAccountPasswordPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete the current account password policy
          The following command removes the password policy from the current AWS account:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteAccountPasswordPolicyRequest request = new DeleteAccountPasswordPolicyRequest();
DeleteAccountPasswordPolicyResult response = client.deleteAccountPasswordPolicy(request);

      • deleteGroup

        public DeleteGroupResult deleteGroup(DeleteGroupRequest request)

        Deletes the specified IAM group. The group must not contain any users or have any attached policies.

        Specified by:
        deleteGroup in interface AmazonIdentityManagement
        Parameters:
        deleteGroupRequest -
        Returns:
        Result of the DeleteGroup operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deleteGroupPolicy

        public DeleteGroupPolicyResult deleteGroupPolicy(DeleteGroupPolicyRequest request)

        Deletes the specified inline policy that is embedded in the specified IAM group.

        A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

        Specified by:
        deleteGroupPolicy in interface AmazonIdentityManagement
        Parameters:
        deleteGroupPolicyRequest -
        Returns:
        Result of the DeleteGroupPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a policy from an IAM group
          The following command deletes the policy named ExamplePolicy from the group named Admins:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteGroupPolicyRequest request = new DeleteGroupPolicyRequest().withGroupName("Admins").withPolicyName("ExamplePolicy");
DeleteGroupPolicyResult response = client.deleteGroupPolicy(request);

      • deleteInstanceProfile

        public DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest request)

        Deletes the specified instance profile. The instance profile must not have an associated role.

        Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

        For more information about instance profiles, see Using instance profiles in the IAM User Guide.

        Specified by:
        deleteInstanceProfile in interface AmazonIdentityManagement
        Parameters:
        deleteInstanceProfileRequest -
        Returns:
        Result of the DeleteInstanceProfile operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete an instance profile
          The following command deletes the instance profile named ExampleInstanceProfile
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteInstanceProfileRequest request = new DeleteInstanceProfileRequest().withInstanceProfileName("ExampleInstanceProfile");
DeleteInstanceProfileResult response = client.deleteInstanceProfile(request);

      • deleteLoginProfile

        public DeleteLoginProfileResult deleteLoginProfile(DeleteLoginProfileRequest request)

        Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.

        You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.

        Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

        Specified by:
        deleteLoginProfile in interface AmazonIdentityManagement
        Parameters:
        deleteLoginProfileRequest -
        Returns:
        Result of the DeleteLoginProfile operation returned by the service.
        Throws:
        EntityTemporarilyUnmodifiableException - The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a password for an IAM user
          The following command deletes the password for the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteLoginProfileRequest request = new DeleteLoginProfileRequest().withUserName("Bob");
DeleteLoginProfileResult response = client.deleteLoginProfile(request);

      • deleteOpenIDConnectProvider

        public DeleteOpenIDConnectProviderResult deleteOpenIDConnectProvider(DeleteOpenIDConnectProviderRequest request)

        Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

        Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

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

        Specified by:
        deleteOpenIDConnectProvider in interface AmazonIdentityManagement
        Parameters:
        deleteOpenIDConnectProviderRequest -
        Returns:
        Result of the DeleteOpenIDConnectProvider operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deletePolicy

        public DeletePolicyResult deletePolicy(DeletePolicyRequest request)

        Deletes the specified managed policy.

        Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

        • Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

        • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

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

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

        Specified by:
        deletePolicy in interface AmazonIdentityManagement
        Parameters:
        deletePolicyRequest -
        Returns:
        Result of the DeletePolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deletePolicyVersion

        public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)

        Deletes the specified version from the specified managed policy.

        You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

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

        Specified by:
        deletePolicyVersion in interface AmazonIdentityManagement
        Parameters:
        deletePolicyVersionRequest -
        Returns:
        Result of the DeletePolicyVersion operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deleteRole

        public DeleteRoleResult deleteRole(DeleteRoleRequest request)

        Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:

        Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

        Specified by:
        deleteRole in interface AmazonIdentityManagement
        Parameters:
        deleteRoleRequest -
        Returns:
        Result of the DeleteRole operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete an IAM role
          The following command removes the role named Test-Role.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteRoleRequest request = new DeleteRoleRequest().withRoleName("Test-Role");
DeleteRoleResult response = client.deleteRole(request);

      • deleteRolePermissionsBoundary

        public DeleteRolePermissionsBoundaryResult deleteRolePermissionsBoundary(DeleteRolePermissionsBoundaryRequest request)

        Deletes the permissions boundary for the specified IAM role.

        You cannot set the boundary for a service-linked role.

        Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.

        Specified by:
        deleteRolePermissionsBoundary in interface AmazonIdentityManagement
        Parameters:
        deleteRolePermissionsBoundaryRequest -
        Returns:
        Result of the DeleteRolePermissionsBoundary operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deleteRolePolicy

        public DeleteRolePolicyResult deleteRolePolicy(DeleteRolePolicyRequest request)

        Deletes the specified inline policy that is embedded in the specified IAM role.

        A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

        Specified by:
        deleteRolePolicy in interface AmazonIdentityManagement
        Parameters:
        deleteRolePolicyRequest -
        Returns:
        Result of the DeleteRolePolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To remove a policy from an IAM role
          The following command removes the policy named ExamplePolicy from the role named Test-Role.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteRolePolicyRequest request = new DeleteRolePolicyRequest().withRoleName("Test-Role").withPolicyName("ExamplePolicy");
DeleteRolePolicyResult response = client.deleteRolePolicy(request);

      • deleteSAMLProvider

        public DeleteSAMLProviderResult deleteSAMLProvider(DeleteSAMLProviderRequest request)

        Deletes a SAML provider resource in IAM.

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

        This operation requires Signature Version 4.

        Specified by:
        deleteSAMLProvider in interface AmazonIdentityManagement
        Parameters:
        deleteSAMLProviderRequest -
        Returns:
        Result of the DeleteSAMLProvider operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deleteServerCertificate

        public DeleteServerCertificateResult deleteServerCertificate(DeleteServerCertificateRequest request)

        Deletes the specified server certificate.

        For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

        If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

        Specified by:
        deleteServerCertificate in interface AmazonIdentityManagement
        Parameters:
        deleteServerCertificateRequest -
        Returns:
        Result of the DeleteServerCertificate operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deleteServiceLinkedRole

        public DeleteServiceLinkedRoleResult deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest request)

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

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

        For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.

        Specified by:
        deleteServiceLinkedRole in interface AmazonIdentityManagement
        Parameters:
        deleteServiceLinkedRoleRequest -
        Returns:
        Result of the DeleteServiceLinkedRole operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • deleteSigningCertificate

        public DeleteSigningCertificateResult deleteSigningCertificate(DeleteSigningCertificateRequest request)

        Deletes a signing certificate associated with the specified IAM user.

        If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.

        Specified by:
        deleteSigningCertificate in interface AmazonIdentityManagement
        Parameters:
        deleteSigningCertificateRequest -
        Returns:
        Result of the DeleteSigningCertificate operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a signing certificate for an IAM user
          The following command deletes the specified signing certificate for the IAM user named Anika.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteSigningCertificateRequest request = new DeleteSigningCertificateRequest().withUserName("Anika").withCertificateId("TA7SMP42TDN5Z26OBPJE7EXAMPLE");
DeleteSigningCertificateResult response = client.deleteSigningCertificate(request);

      • deleteUser

        public DeleteUserResult deleteUser(DeleteUserRequest request)

        Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:

        Specified by:
        deleteUser in interface AmazonIdentityManagement
        Parameters:
        deleteUserRequest -
        Returns:
        Result of the DeleteUser operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To delete an IAM user
          The following command removes the IAM user named Bob from the current account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteUserRequest request = new DeleteUserRequest().withUserName("Bob");
DeleteUserResult response = client.deleteUser(request);

      • deleteUserPolicy

        public DeleteUserPolicyResult deleteUserPolicy(DeleteUserPolicyRequest request)

        Deletes the specified inline policy that is embedded in the specified IAM user.

        A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

        Specified by:
        deleteUserPolicy in interface AmazonIdentityManagement
        Parameters:
        deleteUserPolicyRequest -
        Returns:
        Result of the DeleteUserPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To remove a policy from an IAM user
          The following delete-user-policy command removes the specified policy from the IAM user named Juan:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteUserPolicyRequest request = new DeleteUserPolicyRequest().withUserName("Juan").withPolicyName("ExamplePolicy");
DeleteUserPolicyResult response = client.deleteUserPolicy(request);

      • deleteVirtualMFADevice

        public DeleteVirtualMFADeviceResult deleteVirtualMFADevice(DeleteVirtualMFADeviceRequest request)

        Deletes a virtual MFA device.

        You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

        Specified by:
        deleteVirtualMFADevice in interface AmazonIdentityManagement
        Parameters:
        deleteVirtualMFADeviceRequest -
        Returns:
        Result of the DeleteVirtualMFADevice operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        DeleteConflictException - The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        See Also:
        AWS API Documentation

        Samples:
        • To remove a virtual MFA device
          The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
DeleteVirtualMFADeviceRequest request = new DeleteVirtualMFADeviceRequest().withSerialNumber("arn:aws:iam::123456789012:mfa/ExampleName");
DeleteVirtualMFADeviceResult response = client.deleteVirtualMFADevice(request);

      • detachRolePolicy

        public DetachRolePolicyResult detachRolePolicy(DetachRolePolicyRequest request)

        Removes the specified managed policy from the specified role.

        A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

        Specified by:
        detachRolePolicy in interface AmazonIdentityManagement
        Parameters:
        detachRolePolicyRequest -
        Returns:
        Result of the DetachRolePolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • enableMFADevice

        public EnableMFADeviceResult enableMFADevice(EnableMFADeviceRequest request)

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

        Specified by:
        enableMFADevice in interface AmazonIdentityManagement
        Parameters:
        enableMFADeviceRequest -
        Returns:
        Result of the EnableMFADevice operation returned by the service.
        Throws:
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        EntityTemporarilyUnmodifiableException - The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
        InvalidAuthenticationCodeException - The request was rejected because the authentication code was not recognized. The error message describes the specific error.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        See Also:
        AWS API Documentation

      • generateOrganizationsAccessReport

        public GenerateOrganizationsAccessReportResult generateOrganizationsAccessReport(GenerateOrganizationsAccessReportRequest request)

        Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.

        To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

        You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.

        You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.

        For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.

        The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.

        This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.

        To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.

        • Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.

        • OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.

        • management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.

        • Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.

        To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.

        • Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.

        • OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.

        • management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.

        • Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.

        Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

        For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.

        Specified by:
        generateOrganizationsAccessReport in interface AmazonIdentityManagement
        Parameters:
        generateOrganizationsAccessReportRequest -
        Returns:
        Result of the GenerateOrganizationsAccessReport operation returned by the service.
        Throws:
        ReportGenerationLimitExceededException - The request failed because the maximum number of concurrent requests for this account are already running.
        See Also:
        AWS API Documentation

      • generateServiceLastAccessedDetails

        public GenerateServiceLastAccessedDetailsResult generateServiceLastAccessedDetails(GenerateServiceLastAccessedDetailsRequest request)

        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. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. For more information about services and actions for which action last accessed information is displayed, see IAM action last accessed information services and actions.

        The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.

        The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:

        • GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.

          The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

        • GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.

        To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.

        For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.

        Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

        For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

        Specified by:
        generateServiceLastAccessedDetails in interface AmazonIdentityManagement
        Parameters:
        generateServiceLastAccessedDetailsRequest -
        Returns:
        Result of the GenerateServiceLastAccessedDetails operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        See Also:
        AWS API Documentation

      • getAccountAuthorizationDetails

        public GetAccountAuthorizationDetailsResult getAccountAuthorizationDetails(GetAccountAuthorizationDetailsRequest request)

        Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

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

        You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

        Specified by:
        getAccountAuthorizationDetails in interface AmazonIdentityManagement
        Parameters:
        getAccountAuthorizationDetailsRequest -
        Returns:
        Result of the GetAccountAuthorizationDetails operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • getAccountPasswordPolicy

        public GetAccountPasswordPolicyResult getAccountPasswordPolicy(GetAccountPasswordPolicyRequest request)

        Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.

        Specified by:
        getAccountPasswordPolicy in interface AmazonIdentityManagement
        Parameters:
        getAccountPasswordPolicyRequest -
        Returns:
        Result of the GetAccountPasswordPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To see the current account password policy
          The following command displays details about the password policy for the current AWS account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
GetAccountPasswordPolicyRequest request = new GetAccountPasswordPolicyRequest();
GetAccountPasswordPolicyResult response = client.getAccountPasswordPolicy(request);

      • getAccountSummary

        public GetAccountSummaryResult getAccountSummary(GetAccountSummaryRequest request)

        Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.

        For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.

        Specified by:
        getAccountSummary in interface AmazonIdentityManagement
        Parameters:
        getAccountSummaryRequest -
        Returns:
        Result of the GetAccountSummary operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To get information about IAM entity quotas and usage in the current account
          The following command returns information about the IAM entity quotas and usage in the current AWS account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
GetAccountSummaryRequest request = new GetAccountSummaryRequest();
GetAccountSummaryResult response = client.getAccountSummary(request);

      • getContextKeysForCustomPolicy

        public GetContextKeysForCustomPolicyResult getContextKeysForCustomPolicy(GetContextKeysForCustomPolicyRequest request)

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

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

        Specified by:
        getContextKeysForCustomPolicy in interface AmazonIdentityManagement
        Parameters:
        getContextKeysForCustomPolicyRequest -
        Returns:
        Result of the GetContextKeysForCustomPolicy operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        See Also:
        AWS API Documentation

      • getContextKeysForPrincipalPolicy

        public GetContextKeysForPrincipalPolicyResult getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest request)

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

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

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

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

        Specified by:
        getContextKeysForPrincipalPolicy in interface AmazonIdentityManagement
        Parameters:
        getContextKeysForPrincipalPolicyRequest -
        Returns:
        Result of the GetContextKeysForPrincipalPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        See Also:
        AWS API Documentation

      • getGroup

        public GetGroupResult getGroup(GetGroupRequest request)

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

        Specified by:
        getGroup in interface AmazonIdentityManagement
        Parameters:
        getGroupRequest -
        Returns:
        Result of the GetGroup operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • getGroupPolicy

        public GetGroupPolicyResult getGroupPolicy(GetGroupPolicyRequest request)

        Retrieves the specified inline policy document that is embedded in the specified IAM group.

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

        An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

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

        Specified by:
        getGroupPolicy in interface AmazonIdentityManagement
        Parameters:
        getGroupPolicyRequest -
        Returns:
        Result of the GetGroupPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • getInstanceProfile

        public GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest request)

        Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

        Specified by:
        getInstanceProfile in interface AmazonIdentityManagement
        Parameters:
        getInstanceProfileRequest -
        Returns:
        Result of the GetInstanceProfile operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To get information about an instance profile
          The following command gets information about the instance profile named ExampleInstanceProfile.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
GetInstanceProfileRequest request = new GetInstanceProfileRequest().withInstanceProfileName("ExampleInstanceProfile");
GetInstanceProfileResult response = client.getInstanceProfile(request);

      • getLoginProfile

        public GetLoginProfileResult getLoginProfile(GetLoginProfileRequest request)

        Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity) error.

        If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user.

        If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.

        Specified by:
        getLoginProfile in interface AmazonIdentityManagement
        Parameters:
        getLoginProfileRequest -
        Returns:
        Result of the GetLoginProfile operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To get password information for an IAM user
          The following command gets information about the password for the IAM user named Anika.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
GetLoginProfileRequest request = new GetLoginProfileRequest().withUserName("Anika");
GetLoginProfileResult response = client.getLoginProfile(request);

      • getOrganizationsAccessReport

        public GetOrganizationsAccessReportResult getOrganizationsAccessReport(GetOrganizationsAccessReportRequest request)

        Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.

        Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.

        To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

        For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.

        By default, the list is sorted by service namespace.

        Specified by:
        getOrganizationsAccessReport in interface AmazonIdentityManagement
        Parameters:
        getOrganizationsAccessReportRequest -
        Returns:
        Result of the GetOrganizationsAccessReport operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        See Also:
        AWS API Documentation

      • getPolicy

        public GetPolicyResult getPolicy(GetPolicyRequest request)

        Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

        This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

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

        Specified by:
        getPolicy in interface AmazonIdentityManagement
        Parameters:
        getPolicyRequest -
        Returns:
        Result of the GetPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • getPolicyVersion

        public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest request)

        Retrieves information about the specified version of the specified managed policy, including the policy document.

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

        To list the available versions for a policy, use ListPolicyVersions.

        This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

        For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.

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

        Specified by:
        getPolicyVersion in interface AmazonIdentityManagement
        Parameters:
        getPolicyVersionRequest -
        Returns:
        Result of the GetPolicyVersion operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • getRole

        public GetRoleResult getRole(GetRoleRequest request)

        Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see IAM roles in the IAM User Guide.

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

        Specified by:
        getRole in interface AmazonIdentityManagement
        Parameters:
        getRoleRequest -
        Returns:
        Result of the GetRole operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To get information about an IAM role
          The following command gets information about the role named Test-Role.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
GetRoleRequest request = new GetRoleRequest().withRoleName("Test-Role");
GetRoleResult response = client.getRole(request);

      • getRolePolicy

        public GetRolePolicyResult getRolePolicy(GetRolePolicyRequest request)

        Retrieves the specified inline policy document that is embedded with the specified IAM role.

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

        An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

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

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

        Specified by:
        getRolePolicy in interface AmazonIdentityManagement
        Parameters:
        getRolePolicyRequest -
        Returns:
        Result of the GetRolePolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • getServiceLastAccessedDetails

        public GetServiceLastAccessedDetailsResult getServiceLastAccessedDetails(GetServiceLastAccessedDetailsRequest request)

        Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.

        Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

        For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.

        The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:

        • User – Returns the user ARN that you used to generate the report

        • Group – Returns the ARN of the group member (user) that last attempted to access the service

        • Role – Returns the role ARN that you used to generate the report

        • Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service

        By default, the list is sorted by service namespace.

        If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.

        For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

        Specified by:
        getServiceLastAccessedDetails in interface AmazonIdentityManagement
        Parameters:
        getServiceLastAccessedDetailsRequest -
        Returns:
        Result of the GetServiceLastAccessedDetails operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        See Also:
        AWS API Documentation

      • getServiceLastAccessedDetailsWithEntities

        public GetServiceLastAccessedDetailsWithEntitiesResult getServiceLastAccessedDetailsWithEntities(GetServiceLastAccessedDetailsWithEntitiesRequest request)

        After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.

        • Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.

        • Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.

        You can also use this operation for user or role reports to retrieve details about those entities.

        If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.

        By default, the list of associated entities is sorted by date, with the most recent access listed first.

        Specified by:
        getServiceLastAccessedDetailsWithEntities in interface AmazonIdentityManagement
        Parameters:
        getServiceLastAccessedDetailsWithEntitiesRequest -
        Returns:
        Result of the GetServiceLastAccessedDetailsWithEntities operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        See Also:
        AWS API Documentation

      • getUser

        public GetUserResult getUser(GetUserRequest request)

        Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.

        If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.

        Specified by:
        getUser in interface AmazonIdentityManagement
        Parameters:
        getUserRequest -
        Returns:
        Result of the GetUser operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To get information about an IAM user
          The following command gets information about the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
GetUserRequest request = new GetUserRequest().withUserName("Bob");
GetUserResult response = client.getUser(request);

      • getUserPolicy

        public GetUserPolicyResult getUserPolicy(GetUserPolicyRequest request)

        Retrieves the specified inline policy document that is embedded in the specified IAM user.

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

        An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

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

        Specified by:
        getUserPolicy in interface AmazonIdentityManagement
        Parameters:
        getUserPolicyRequest -
        Returns:
        Result of the GetUserPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listAccessKeys

        public ListAccessKeysResult listAccessKeys(ListAccessKeysRequest request)

        Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.

        Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

        If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required.

        This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.

        To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.

        Specified by:
        listAccessKeys in interface AmazonIdentityManagement
        Parameters:
        listAccessKeysRequest -
        Returns:
        Result of the ListAccessKeys operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list the access key IDs for an IAM user
          The following command lists the access keys IDs for the IAM user named Alice.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListAccessKeysRequest request = new ListAccessKeysRequest().withUserName("Alice");
ListAccessKeysResult response = client.listAccessKeys(request);

      • listAccountAliases

        public ListAccountAliasesResult listAccountAliases(ListAccountAliasesRequest request)

        Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

        Specified by:
        listAccountAliases in interface AmazonIdentityManagement
        Parameters:
        listAccountAliasesRequest -
        Returns:
        Result of the ListAccountAliases operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list account aliases
          The following command lists the aliases for the current account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListAccountAliasesRequest request = new ListAccountAliasesRequest();
ListAccountAliasesResult response = client.listAccountAliases(request);

      • listAttachedGroupPolicies

        public ListAttachedGroupPoliciesResult listAttachedGroupPolicies(ListAttachedGroupPoliciesRequest request)

        Lists all managed policies that are attached to the specified IAM group.

        An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

        You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

        Specified by:
        listAttachedGroupPolicies in interface AmazonIdentityManagement
        Parameters:
        listAttachedGroupPoliciesRequest -
        Returns:
        Result of the ListAttachedGroupPolicies operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listAttachedRolePolicies

        public ListAttachedRolePoliciesResult listAttachedRolePolicies(ListAttachedRolePoliciesRequest request)

        Lists all managed policies that are attached to the specified IAM role.

        An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

        You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

        Specified by:
        listAttachedRolePolicies in interface AmazonIdentityManagement
        Parameters:
        listAttachedRolePoliciesRequest -
        Returns:
        Result of the ListAttachedRolePolicies operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listAttachedUserPolicies

        public ListAttachedUserPoliciesResult listAttachedUserPolicies(ListAttachedUserPoliciesRequest request)

        Lists all managed policies that are attached to the specified IAM user.

        An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

        You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

        Specified by:
        listAttachedUserPolicies in interface AmazonIdentityManagement
        Parameters:
        listAttachedUserPoliciesRequest -
        Returns:
        Result of the ListAttachedUserPolicies operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listEntitiesForPolicy

        public ListEntitiesForPolicyResult listEntitiesForPolicy(ListEntitiesForPolicyRequest request)

        Lists all IAM users, groups, and roles that the specified managed policy is attached to.

        You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

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

        Specified by:
        listEntitiesForPolicy in interface AmazonIdentityManagement
        Parameters:
        listEntitiesForPolicyRequest -
        Returns:
        Result of the ListEntitiesForPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listGroupPolicies

        public ListGroupPoliciesResult listGroupPolicies(ListGroupPoliciesRequest request)

        Lists the names of the inline policies that are embedded in the specified IAM group.

        An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

        You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

        Specified by:
        listGroupPolicies in interface AmazonIdentityManagement
        Parameters:
        listGroupPoliciesRequest -
        Returns:
        Result of the ListGroupPolicies operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list the in-line policies for an IAM group
          The following command lists the names of in-line policies that are embedded in the IAM group named Admins.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListGroupPoliciesRequest request = new ListGroupPoliciesRequest().withGroupName("Admins");
ListGroupPoliciesResult response = client.listGroupPolicies(request);

      • listGroups

        public ListGroupsResult listGroups(ListGroupsRequest request)

        Lists the IAM groups that have the specified path prefix.

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

        Specified by:
        listGroups in interface AmazonIdentityManagement
        Parameters:
        listGroupsRequest -
        Returns:
        Result of the ListGroups operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list the IAM groups for the current account
          The following command lists the IAM groups in the current account:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListGroupsRequest request = new ListGroupsRequest();
ListGroupsResult response = client.listGroups(request);

      • listGroupsForUser

        public ListGroupsForUserResult listGroupsForUser(ListGroupsForUserRequest request)

        Lists the IAM groups that the specified IAM user belongs to.

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

        Specified by:
        listGroupsForUser in interface AmazonIdentityManagement
        Parameters:
        listGroupsForUserRequest -
        Returns:
        Result of the ListGroupsForUser operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list the groups that an IAM user belongs to
          The following command displays the groups that the IAM user named Bob belongs to.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListGroupsForUserRequest request = new ListGroupsForUserRequest().withUserName("Bob");
ListGroupsForUserResult response = client.listGroupsForUser(request);

      • listInstanceProfiles

        public ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest request)

        Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

        IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.

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

        Specified by:
        listInstanceProfiles in interface AmazonIdentityManagement
        Parameters:
        listInstanceProfilesRequest -
        Returns:
        Result of the ListInstanceProfiles operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listMFADevices

        public ListMFADevicesResult listMFADevices(ListMFADevicesRequest request)

        Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.

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

        Specified by:
        listMFADevices in interface AmazonIdentityManagement
        Parameters:
        listMFADevicesRequest -
        Returns:
        Result of the ListMFADevices operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listPolicies

        public ListPoliciesResult listPolicies(ListPoliciesRequest request)

        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.

        You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS.

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

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

        IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.

        Specified by:
        listPolicies in interface AmazonIdentityManagement
        Parameters:
        listPoliciesRequest -
        Returns:
        Result of the ListPolicies operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listPoliciesGrantingServiceAccess

        public ListPoliciesGrantingServiceAccessResult listPoliciesGrantingServiceAccess(ListPoliciesGrantingServiceAccessRequest request)

        Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.

        This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

        The list of policies returned by the operation depends on the ARN of the identity that you provide.

        • User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.

        • Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.

        • Role – The list of policies includes only the managed and inline policies that are attached to the role.

        For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

        Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.

        Specified by:
        listPoliciesGrantingServiceAccess in interface AmazonIdentityManagement
        Parameters:
        listPoliciesGrantingServiceAccessRequest -
        Returns:
        Result of the ListPoliciesGrantingServiceAccess operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        See Also:
        AWS API Documentation

      • listRolePolicies

        public ListRolePoliciesResult listRolePolicies(ListRolePoliciesRequest request)

        Lists the names of the inline policies that are embedded in the specified IAM role.

        An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

        You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

        Specified by:
        listRolePolicies in interface AmazonIdentityManagement
        Parameters:
        listRolePoliciesRequest -
        Returns:
        Result of the ListRolePolicies operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listRoles

        public ListRolesResult listRoles(ListRolesRequest request)

        Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.

        IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

        • PermissionsBoundary

        • RoleLastUsed

        • Tags

        To view all of the information for a role, see GetRole.

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

        Specified by:
        listRoles in interface AmazonIdentityManagement
        Parameters:
        listRolesRequest -
        Returns:
        Result of the ListRoles operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listSAMLProviders

        public ListSAMLProvidersResult listSAMLProviders(ListSAMLProvidersRequest request)

        Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

        This operation requires Signature Version 4.

        Specified by:
        listSAMLProviders in interface AmazonIdentityManagement
        Parameters:
        listSAMLProvidersRequest -
        Returns:
        Result of the ListSAMLProviders operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listSSHPublicKeys

        public ListSSHPublicKeysResult listSSHPublicKeys(ListSSHPublicKeysRequest request)

        Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.

        The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

        Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

        Specified by:
        listSSHPublicKeys in interface AmazonIdentityManagement
        Parameters:
        listSSHPublicKeysRequest -
        Returns:
        Result of the ListSSHPublicKeys operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        See Also:
        AWS API Documentation

      • listServerCertificateTags

        public ListServerCertificateTagsResult listServerCertificateTags(ListServerCertificateTagsRequest request)

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

        For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

        Specified by:
        listServerCertificateTags in interface AmazonIdentityManagement
        Parameters:
        listServerCertificateTagsRequest -
        Returns:
        Result of the ListServerCertificateTags operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listServerCertificates

        public ListServerCertificatesResult listServerCertificates(ListServerCertificatesRequest request)

        Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.

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

        For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

        IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.

        Specified by:
        listServerCertificates in interface AmazonIdentityManagement
        Parameters:
        listServerCertificatesRequest -
        Returns:
        Result of the ListServerCertificates operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listSigningCertificates

        public ListSigningCertificatesResult listSigningCertificates(ListSigningCertificatesRequest request)

        Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.

        Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

        If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

        Specified by:
        listSigningCertificates in interface AmazonIdentityManagement
        Parameters:
        listSigningCertificatesRequest -
        Returns:
        Result of the ListSigningCertificates operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list the signing certificates for an IAM user
          The following command lists the signing certificates for the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListSigningCertificatesRequest request = new ListSigningCertificatesRequest().withUserName("Bob");
ListSigningCertificatesResult response = client.listSigningCertificates(request);

      • listUserPolicies

        public ListUserPoliciesResult listUserPolicies(ListUserPoliciesRequest request)

        Lists the names of the inline policies embedded in the specified IAM user.

        An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

        You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

        Specified by:
        listUserPolicies in interface AmazonIdentityManagement
        Parameters:
        listUserPoliciesRequest -
        Returns:
        Result of the ListUserPolicies operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • listUsers

        public ListUsersResult listUsers(ListUsersRequest request)

        Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.

        IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

        • PermissionsBoundary

        • Tags

        To view all of the information for a user, see GetUser.

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

        Specified by:
        listUsers in interface AmazonIdentityManagement
        Parameters:
        listUsersRequest -
        Returns:
        Result of the ListUsers operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To list IAM users
          The following command lists the IAM users in the current account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListUsersRequest request = new ListUsersRequest();
ListUsersResult response = client.listUsers(request);

      • listVirtualMFADevices

        public ListVirtualMFADevicesResult listVirtualMFADevices(ListVirtualMFADevicesRequest request)

        Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

        IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.

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

        Specified by:
        listVirtualMFADevices in interface AmazonIdentityManagement
        Parameters:
        listVirtualMFADevicesRequest -
        Returns:
        Result of the ListVirtualMFADevices operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list virtual MFA devices
          The following command lists the virtual MFA devices that have been configured for the current account.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
ListVirtualMFADevicesRequest request = new ListVirtualMFADevicesRequest();
ListVirtualMFADevicesResult response = client.listVirtualMFADevices(request);

      • putGroupPolicy

        public PutGroupPolicyResult putGroupPolicy(PutGroupPolicyRequest request)

        Adds or updates an inline policy document that is embedded in the specified IAM group.

        A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

        For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.

        Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

        Specified by:
        putGroupPolicy in interface AmazonIdentityManagement
        Parameters:
        putGroupPolicyRequest -
        Returns:
        Result of the PutGroupPolicy operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To add a policy to a group
          The following command adds a policy named AllPerms to the IAM group named Admins.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
PutGroupPolicyRequest request = new PutGroupPolicyRequest().withGroupName("Admins").withPolicyName("AllPerms")
 .withPolicyDocument("{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}");
PutGroupPolicyResult response = client.putGroupPolicy(request);

      • putRolePermissionsBoundary

        public PutRolePermissionsBoundaryResult putRolePermissionsBoundary(PutRolePermissionsBoundaryRequest request)

        Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.

        You cannot set the boundary for a service-linked role.

        Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

        Specified by:
        putRolePermissionsBoundary in interface AmazonIdentityManagement
        Parameters:
        putRolePermissionsBoundaryRequest -
        Returns:
        Result of the PutRolePermissionsBoundary operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        PolicyNotAttachableException - The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • putRolePolicy

        public PutRolePolicyResult putRolePolicy(PutRolePolicyRequest request)

        Adds or updates an inline policy document that is embedded in the specified IAM role.

        When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumeRolePolicy . For more information about roles, see IAM roles in the IAM User Guide.

        A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

        For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.

        Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

        Specified by:
        putRolePolicy in interface AmazonIdentityManagement
        Parameters:
        putRolePolicyRequest -
        Returns:
        Result of the PutRolePolicy operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To attach a permissions policy to an IAM role
          The following command adds a permissions policy to the role named Test-Role.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
PutRolePolicyRequest request = new PutRolePolicyRequest().withRoleName("S3Access").withPolicyName("S3AccessPolicy")
 .withPolicyDocument("{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}");
PutRolePolicyResult response = client.putRolePolicy(request);

      • putUserPermissionsBoundary

        public PutUserPermissionsBoundaryResult putUserPermissionsBoundary(PutUserPermissionsBoundaryRequest request)

        Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.

        Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

        Specified by:
        putUserPermissionsBoundary in interface AmazonIdentityManagement
        Parameters:
        putUserPermissionsBoundaryRequest -
        Returns:
        Result of the PutUserPermissionsBoundary operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        PolicyNotAttachableException - The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • putUserPolicy

        public PutUserPolicyResult putUserPolicy(PutUserPolicyRequest request)

        Adds or updates an inline policy document that is embedded in the specified IAM user.

        An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

        For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.

        Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

        Specified by:
        putUserPolicy in interface AmazonIdentityManagement
        Parameters:
        putUserPolicyRequest -
        Returns:
        Result of the PutUserPolicy operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To attach a policy to an IAM user
          The following command attaches a policy to the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
PutUserPolicyRequest request = new PutUserPolicyRequest().withUserName("Bob").withPolicyName("AllAccessPolicy")
 .withPolicyDocument("{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}");
PutUserPolicyResult response = client.putUserPolicy(request);

      • removeRoleFromInstanceProfile

        public RemoveRoleFromInstanceProfileResult removeRoleFromInstanceProfile(RemoveRoleFromInstanceProfileRequest request)

        Removes the specified IAM role from the specified Amazon EC2 instance profile.

        Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

        For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

        Specified by:
        removeRoleFromInstanceProfile in interface AmazonIdentityManagement
        Parameters:
        removeRoleFromInstanceProfileRequest -
        Returns:
        Result of the RemoveRoleFromInstanceProfile operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To remove a role from an instance profile
          The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
RemoveRoleFromInstanceProfileRequest request = new RemoveRoleFromInstanceProfileRequest().withInstanceProfileName("ExampleInstanceProfile")
 .withRoleName("Test-Role");
RemoveRoleFromInstanceProfileResult response = client.removeRoleFromInstanceProfile(request);

      • removeUserFromGroup

        public RemoveUserFromGroupResult removeUserFromGroup(RemoveUserFromGroupRequest request)

        Removes the specified user from the specified group.

        Specified by:
        removeUserFromGroup in interface AmazonIdentityManagement
        Parameters:
        removeUserFromGroupRequest -
        Returns:
        Result of the RemoveUserFromGroup operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To remove a user from an IAM group
          The following command removes the user named Bob from the IAM group named Admins.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
RemoveUserFromGroupRequest request = new RemoveUserFromGroupRequest().withGroupName("Admins").withUserName("Bob");
RemoveUserFromGroupResult response = client.removeUserFromGroup(request);

      • resyncMFADevice

        public ResyncMFADeviceResult resyncMFADevice(ResyncMFADeviceRequest request)

        Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.

        For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

        Specified by:
        resyncMFADevice in interface AmazonIdentityManagement
        Parameters:
        resyncMFADeviceRequest -
        Returns:
        Result of the ResyncMFADevice operation returned by the service.
        Throws:
        InvalidAuthenticationCodeException - The request was rejected because the authentication code was not recognized. The error message describes the specific error.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        See Also:
        AWS API Documentation

      • setSecurityTokenServicePreferences

        public SetSecurityTokenServicePreferencesResult setSecurityTokenServicePreferences(SetSecurityTokenServicePreferencesRequest request)

        Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

        By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.

        If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

        To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

        Specified by:
        setSecurityTokenServicePreferences in interface AmazonIdentityManagement
        Parameters:
        setSecurityTokenServicePreferencesRequest -
        Returns:
        Result of the SetSecurityTokenServicePreferences operation returned by the service.
        Throws:
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • simulateCustomPolicy

        public SimulateCustomPolicyResult simulateCustomPolicy(SimulateCustomPolicyRequest request)

        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. The policies are provided as strings.

        The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.

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

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

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

        The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

        Specified by:
        simulateCustomPolicy in interface AmazonIdentityManagement
        Parameters:
        simulateCustomPolicyRequest -
        Returns:
        Result of the SimulateCustomPolicy operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        PolicyEvaluationException - The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.
        See Also:
        AWS API Documentation

      • simulatePrincipalPolicy

        public SimulatePrincipalPolicyResult simulatePrincipalPolicy(SimulatePrincipalPolicyRequest request)

        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. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.

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

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

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

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

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

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

        The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

        Specified by:
        simulatePrincipalPolicy in interface AmazonIdentityManagement
        Parameters:
        simulatePrincipalPolicyRequest -
        Returns:
        Result of the SimulatePrincipalPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        PolicyEvaluationException - The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.
        See Also:
        AWS API Documentation

      • tagInstanceProfile

        public TagInstanceProfileResult tagInstanceProfile(TagInstanceProfileRequest request)

        Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        Specified by:
        tagInstanceProfile in interface AmazonIdentityManagement
        Parameters:
        tagInstanceProfileRequest -
        Returns:
        Result of the TagInstanceProfile operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagMFADevice

        public TagMFADeviceResult tagMFADevice(TagMFADeviceRequest request)

        Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        Specified by:
        tagMFADevice in interface AmazonIdentityManagement
        Parameters:
        tagMFADeviceRequest -
        Returns:
        Result of the TagMFADevice operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagOpenIDConnectProvider

        public TagOpenIDConnectProviderResult tagOpenIDConnectProvider(TagOpenIDConnectProviderRequest request)

        Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        Specified by:
        tagOpenIDConnectProvider in interface AmazonIdentityManagement
        Parameters:
        tagOpenIDConnectProviderRequest -
        Returns:
        Result of the TagOpenIDConnectProvider operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagPolicy

        public TagPolicyResult tagPolicy(TagPolicyRequest request)

        Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        Specified by:
        tagPolicy in interface AmazonIdentityManagement
        Parameters:
        tagPolicyRequest -
        Returns:
        Result of the TagPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagRole

        public TagRoleResult tagRole(TagRoleRequest request)

        Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        For more information about tagging, see Tagging IAM identities in the IAM User Guide.

        Specified by:
        tagRole in interface AmazonIdentityManagement
        Parameters:
        tagRoleRequest -
        Returns:
        Result of the TagRole operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagSAMLProvider

        public TagSAMLProviderResult tagSAMLProvider(TagSAMLProviderRequest request)

        Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        Specified by:
        tagSAMLProvider in interface AmazonIdentityManagement
        Parameters:
        tagSAMLProviderRequest -
        Returns:
        Result of the TagSAMLProvider operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagServerCertificate

        public TagServerCertificateResult tagServerCertificate(TagServerCertificateRequest request)

        Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        Specified by:
        tagServerCertificate in interface AmazonIdentityManagement
        Parameters:
        tagServerCertificateRequest -
        Returns:
        Result of the TagServerCertificate operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • tagUser

        public TagUserResult tagUser(TagUserRequest request)

        Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

        A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

        • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

        • Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

        • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

        • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

        For more information about tagging, see Tagging IAM identities in the IAM User Guide.

        Specified by:
        tagUser in interface AmazonIdentityManagement
        Parameters:
        tagUserRequest -
        Returns:
        Result of the TagUser operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • untagServerCertificate

        public UntagServerCertificateResult untagServerCertificate(UntagServerCertificateRequest request)

        Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

        Specified by:
        untagServerCertificate in interface AmazonIdentityManagement
        Parameters:
        untagServerCertificateRequest -
        Returns:
        Result of the UntagServerCertificate operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • updateAccessKey

        public UpdateAccessKeyResult updateAccessKey(UpdateAccessKeyRequest request)

        Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.

        If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

        For information about rotating keys, see Managing keys and certificates in the IAM User Guide.

        Specified by:
        updateAccessKey in interface AmazonIdentityManagement
        Parameters:
        updateAccessKeyRequest -
        Returns:
        Result of the UpdateAccessKey operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To activate or deactivate an access key for an IAM user
          The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateAccessKeyRequest request = new UpdateAccessKeyRequest().withUserName("Bob").withAccessKeyId("AKIAIOSFODNN7EXAMPLE").withStatus("Inactive");
UpdateAccessKeyResult response = client.updateAccessKey(request);

      • updateAccountPasswordPolicy

        public UpdateAccountPasswordPolicyResult updateAccountPasswordPolicy(UpdateAccountPasswordPolicyRequest request)

        Updates the password policy settings for the Amazon Web Services account.

        This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.

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

        Specified by:
        updateAccountPasswordPolicy in interface AmazonIdentityManagement
        Parameters:
        updateAccountPasswordPolicyRequest -
        Returns:
        Result of the UpdateAccountPasswordPolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To set or change the current account password policy
          The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateAccountPasswordPolicyRequest request = new UpdateAccountPasswordPolicyRequest().withMinimumPasswordLength(8).withRequireNumbers(true);
UpdateAccountPasswordPolicyResult response = client.updateAccountPasswordPolicy(request);

      • updateAssumeRolePolicy

        public UpdateAssumeRolePolicyResult updateAssumeRolePolicy(UpdateAssumeRolePolicyRequest request)

        Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities.

        Specified by:
        updateAssumeRolePolicy in interface AmazonIdentityManagement
        Parameters:
        updateAssumeRolePolicyRequest -
        Returns:
        Result of the UpdateAssumeRolePolicy operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        MalformedPolicyDocumentException - The request was rejected because the policy document was malformed. The error message describes the specific error.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To update the trust policy for an IAM role
          The following command updates the role trust policy for the role named Test-Role:
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateAssumeRolePolicyRequest request = new UpdateAssumeRolePolicyRequest()
 .withRoleName("S3AccessForEC2Instances")
 .withPolicyDocument(
 "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}");
UpdateAssumeRolePolicyResult response = client.updateAssumeRolePolicy(request);

      • updateGroup

        public UpdateGroupResult updateGroup(UpdateGroupRequest request)

        Updates the name and/or the path of the specified IAM group.

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

        The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.

        Specified by:
        updateGroup in interface AmazonIdentityManagement
        Parameters:
        updateGroupRequest -
        Returns:
        Result of the UpdateGroup operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To rename an IAM group
          The following command changes the name of the IAM group Test to Test-1.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateGroupRequest request = new UpdateGroupRequest().withGroupName("Test").withNewGroupName("Test-1");
UpdateGroupResult response = client.updateGroup(request);

      • updateLoginProfile

        public UpdateLoginProfileResult updateLoginProfile(UpdateLoginProfileRequest request)

        Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.

        For more information about modifying passwords, see Managing passwords in the IAM User Guide.

        Specified by:
        updateLoginProfile in interface AmazonIdentityManagement
        Parameters:
        updateLoginProfileRequest -
        Returns:
        Result of the UpdateLoginProfile operation returned by the service.
        Throws:
        EntityTemporarilyUnmodifiableException - The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        PasswordPolicyViolationException - The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To change the password for an IAM user
          The following command creates or changes the password for the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateLoginProfileRequest request = new UpdateLoginProfileRequest().withUserName("Bob").withPassword("SomeKindOfPassword123!@#");
UpdateLoginProfileResult response = client.updateLoginProfile(request);

      • updateOpenIDConnectProviderThumbprint

        public UpdateOpenIDConnectProviderThumbprintResult updateOpenIDConnectProviderThumbprint(UpdateOpenIDConnectProviderThumbprintRequest request)

        Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

        The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

        Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

        Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub, GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint.

        Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.

        Specified by:
        updateOpenIDConnectProviderThumbprint in interface AmazonIdentityManagement
        Parameters:
        updateOpenIDConnectProviderThumbprintRequest -
        Returns:
        Result of the UpdateOpenIDConnectProviderThumbprint operation returned by the service.
        Throws:
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • updateRole

        public UpdateRoleResult updateRole(UpdateRoleRequest request)

        Updates the description or maximum session duration setting of a role.

        Specified by:
        updateRole in interface AmazonIdentityManagement
        Parameters:
        updateRoleRequest -
        Returns:
        Result of the UpdateRole operation returned by the service.
        Throws:
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • updateRoleDescription

        public UpdateRoleDescriptionResult updateRoleDescription(UpdateRoleDescriptionRequest request)

        Use UpdateRole instead.

        Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.

        Specified by:
        updateRoleDescription in interface AmazonIdentityManagement
        Parameters:
        updateRoleDescriptionRequest -
        Returns:
        Result of the UpdateRoleDescription operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        UnmodifiableEntityException - The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • updateSSHPublicKey

        public UpdateSSHPublicKeyResult updateSSHPublicKey(UpdateSSHPublicKeyRequest request)

        Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.

        The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

        Specified by:
        updateSSHPublicKey in interface AmazonIdentityManagement
        Parameters:
        updateSSHPublicKeyRequest -
        Returns:
        Result of the UpdateSSHPublicKey operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        See Also:
        AWS API Documentation

      • updateServerCertificate

        public UpdateServerCertificateResult updateServerCertificate(UpdateServerCertificateRequest request)

        Updates the name and/or the path of the specified server certificate stored in IAM.

        For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

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

        The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.

        Specified by:
        updateServerCertificate in interface AmazonIdentityManagement
        Parameters:
        updateServerCertificateRequest -
        Returns:
        Result of the UpdateServerCertificate operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

      • updateServiceSpecificCredential

        public UpdateServiceSpecificCredentialResult updateServiceSpecificCredential(UpdateServiceSpecificCredentialRequest request)

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

        Specified by:
        updateServiceSpecificCredential in interface AmazonIdentityManagement
        Parameters:
        updateServiceSpecificCredentialRequest -
        Returns:
        Result of the UpdateServiceSpecificCredential operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        See Also:
        AWS API Documentation

      • updateSigningCertificate

        public UpdateSigningCertificateResult updateSigningCertificate(UpdateSigningCertificateRequest request)

        Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

        If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

        Specified by:
        updateSigningCertificate in interface AmazonIdentityManagement
        Parameters:
        updateSigningCertificateRequest -
        Returns:
        Result of the UpdateSigningCertificate operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To change the active status of a signing certificate for an IAM user
          The following command changes the status of a signing certificate for a user named Bob to Inactive.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateSigningCertificateRequest request = new UpdateSigningCertificateRequest().withUserName("Bob").withCertificateId("TA7SMP42TDN5Z26OBPJE7EXAMPLE")
 .withStatus("Inactive");
UpdateSigningCertificateResult response = client.updateSigningCertificate(request);

      • updateUser

        public UpdateUserResult updateUser(UpdateUserRequest request)

        Updates the name and/or the path of the specified IAM user.

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

        To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.

        Specified by:
        updateUser in interface AmazonIdentityManagement
        Parameters:
        updateUserRequest -
        Returns:
        Result of the UpdateUser operation returned by the service.
        Throws:
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        EntityTemporarilyUnmodifiableException - The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To change an IAM user's name
          The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UpdateUserRequest request = new UpdateUserRequest().withUserName("Bob").withNewUserName("Robert");
UpdateUserResult response = client.updateUser(request);

      • uploadSSHPublicKey

        public UploadSSHPublicKeyResult uploadSSHPublicKey(UploadSSHPublicKeyRequest request)

        Uploads an SSH public key and associates it with the specified IAM user.

        The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

        Specified by:
        uploadSSHPublicKey in interface AmazonIdentityManagement
        Parameters:
        uploadSSHPublicKeyRequest -
        Returns:
        Result of the UploadSSHPublicKey operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        InvalidPublicKeyException - The request was rejected because the public key is malformed or otherwise invalid.
        DuplicateSSHPublicKeyException - The request was rejected because the SSH public key is already associated with the specified IAM user.
        UnrecognizedPublicKeyEncodingException - The request was rejected because the public key encoding format is unsupported or unrecognized.
        See Also:
        AWS API Documentation

      • uploadServerCertificate

        public UploadServerCertificateResult uploadServerCertificate(UploadServerCertificateRequest request)

        Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

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

        For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

        For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.

        Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide.

        Specified by:
        uploadServerCertificate in interface AmazonIdentityManagement
        Parameters:
        uploadServerCertificateRequest -
        Returns:
        Result of the UploadServerCertificate operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        InvalidInputException - The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        MalformedCertificateException - The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
        KeyPairMismatchException - The request was rejected because the public key certificate and the private key do not match.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:

      • uploadSigningCertificate

        public UploadSigningCertificateResult uploadSigningCertificate(UploadSigningCertificateRequest request)

        Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

        For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.

        If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

        Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

        Specified by:
        uploadSigningCertificate in interface AmazonIdentityManagement
        Parameters:
        uploadSigningCertificateRequest -
        Returns:
        Result of the UploadSigningCertificate operation returned by the service.
        Throws:
        LimitExceededException - The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
        EntityAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.
        MalformedCertificateException - The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
        InvalidCertificateException - The request was rejected because the certificate is invalid.
        DuplicateCertificateException - The request was rejected because the same certificate is associated with an IAM user in the account.
        NoSuchEntityException - The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
        ConcurrentModificationException - The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
        ServiceFailureException - The request processing has failed because of an unknown error, exception or failure.
        See Also:
        AWS API Documentation

        Samples:
        • To upload a signing certificate for an IAM user
          The following command uploads a signing certificate for the IAM user named Bob.
          AmazonIdentityManagement client = AmazonIdentityManagementClientBuilder.standard().build();
UploadSigningCertificateRequest request = new UploadSigningCertificateRequest().withUserName("Bob").withCertificateBody(
 "-----BEGIN CERTIFICATE----------END CERTIFICATE-----");
UploadSigningCertificateResult response = client.uploadSigningCertificate(request);

      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AmazonIdentityManagement
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /