AddClientIDToOpenIDConnectProvider

$result = $client->addClientIDToOpenIDConnectProvider([/* ... */]);
$promise = $client->addClientIDToOpenIDConnectProviderAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addClientIDToOpenIDConnectProvider([
    'ClientID' => '<string>', // REQUIRED
    'OpenIDConnectProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: 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:

$result = $client->addClientIDToOpenIDConnectProvider([
    'ClientID' => 'my-application-ID',
    'OpenIDConnectProviderArn' => 'arn:aws:iam::123456789012:oidc-provider/server.example.com',
]);

AddRoleToInstanceProfile

$result = $client->addRoleToInstanceProfile([/* ... */]);
$promise = $client->addRoleToInstanceProfileAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->addRoleToInstanceProfile([
    'InstanceProfileName' => '<string>', // REQUIRED
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To add a role to an instance profile

The following command adds the role named S3Access to the instance profile named Webserver:

$result = $client->addRoleToInstanceProfile([
    'InstanceProfileName' => 'Webserver',
    'RoleName' => 'S3Access',
]);

AddUserToGroup

$result = $client->addUserToGroup([/* ... */]);
$promise = $client->addUserToGroupAsync([/* ... */]);

Adds the specified user to the specified group.

Parameter Syntax

$result = $client->addUserToGroup([
    'GroupName' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To add a user to an IAM group

The following command adds an IAM user named Bob to the IAM group named Admins:

$result = $client->addUserToGroup([
    'GroupName' => 'Admins',
    'UserName' => 'Bob',
]);

AttachGroupPolicy

$result = $client->attachGroupPolicy([/* ... */]);
$promise = $client->attachGroupPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->attachGroupPolicy([
    'GroupName' => '<string>', // REQUIRED
    'PolicyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->attachGroupPolicy([
    'GroupName' => 'Finance',
    'PolicyArn' => 'arn:aws:iam::aws:policy/ReadOnlyAccess',
]);

AttachRolePolicy

$result = $client->attachRolePolicy([/* ... */]);
$promise = $client->attachRolePolicyAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->attachRolePolicy([
    'PolicyArn' => '<string>', // REQUIRED
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->attachRolePolicy([
    'PolicyArn' => 'arn:aws:iam::aws:policy/ReadOnlyAccess',
    'RoleName' => 'ReadOnlyRole',
]);

AttachUserPolicy

$result = $client->attachUserPolicy([/* ... */]);
$promise = $client->attachUserPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->attachUserPolicy([
    'PolicyArn' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->attachUserPolicy([
    'PolicyArn' => 'arn:aws:iam::aws:policy/AdministratorAccess',
    'UserName' => 'Alice',
]);

ChangePassword

$result = $client->changePassword([/* ... */]);
$promise = $client->changePasswordAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->changePassword([
    'NewPassword' => '<string>', // REQUIRED
    'OldPassword' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To change the password for your IAM user

The following command changes the password for the current IAM user.

$result = $client->changePassword([
    'NewPassword' => ']35d/{pB9Fo9wJ',
    'OldPassword' => '3s0K_;xh4~8XXI',
]);

CreateAccessKey

$result = $client->createAccessKey([/* ... */]);
$promise = $client->createAccessKeyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAccessKey([
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccessKey' => [
        'AccessKeyId' => '<string>',
        'CreateDate' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'Status' => 'Active|Inactive',
        'UserName' => '<string>',
    ],
]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->createAccessKey([
    'UserName' => 'Bob',
]);

Result syntax:

[
    'AccessKey' => [
        'AccessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
        'CreateDate' => ,
        'SecretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY',
        'Status' => 'Active',
        'UserName' => 'Bob',
    ],
]

CreateAccountAlias

$result = $client->createAccountAlias([/* ... */]);
$promise = $client->createAccountAliasAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAccountAlias([
    'AccountAlias' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To create an account alias

The following command associates the alias examplecorp to your AWS account.

$result = $client->createAccountAlias([
    'AccountAlias' => 'examplecorp',
]);

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a new group.

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

Parameter Syntax

$result = $client->createGroup([
    'GroupName' => '<string>', // REQUIRED
    'Path' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'Arn' => '<string>',
        'CreateDate' => <DateTime>,
        'GroupId' => '<string>',
        'GroupName' => '<string>',
        'Path' => '<string>',
    ],
]

Result Details

Errors

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.

Examples

Example 1: To create an IAM group

The following command creates an IAM group named Admins.

$result = $client->createGroup([
    'GroupName' => 'Admins',
]);

Result syntax:

[
    'Group' => [
        'Arn' => 'arn:aws:iam::123456789012:group/Admins',
        'CreateDate' => ,
        'GroupId' => 'AIDGPMS9RO4H3FEXAMPLE',
        'GroupName' => 'Admins',
        'Path' => '/',
    ],
]

CreateInstanceProfile

$result = $client->createInstanceProfile([/* ... */]);
$promise = $client->createInstanceProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createInstanceProfile([
    'InstanceProfileName' => '<string>', // REQUIRED
    'Path' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'InstanceProfile' => [
        'Arn' => '<string>',
        'CreateDate' => <DateTime>,
        'InstanceProfileId' => '<string>',
        'InstanceProfileName' => '<string>',
        'Path' => '<string>',
        'Roles' => [
            [
                'Arn' => '<string>',
                'AssumeRolePolicyDocument' => '<string>',
                'CreateDate' => <DateTime>,
                'Description' => '<string>',
                'MaxSessionDuration' => <integer>,
                'Path' => '<string>',
                'PermissionsBoundary' => [
                    'PermissionsBoundaryArn' => '<string>',
                    'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
                ],
                'RoleId' => '<string>',
                'RoleLastUsed' => [
                    'LastUsedDate' => <DateTime>,
                    'Region' => '<string>',
                ],
                'RoleName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->createInstanceProfile([
    'InstanceProfileName' => 'Webserver',
]);

Result syntax:

[
    'InstanceProfile' => [
        'Arn' => 'arn:aws:iam::123456789012:instance-profile/Webserver',
        'CreateDate' => ,
        'InstanceProfileId' => 'AIPAJMBYC7DLSPEXAMPLE',
        'InstanceProfileName' => 'Webserver',
        'Path' => '/',
        'Roles' => [
        ],
    ],
]

CreateLoginProfile

$result = $client->createLoginProfile([/* ... */]);
$promise = $client->createLoginProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createLoginProfile([
    'Password' => '<string>',
    'PasswordResetRequired' => true || false,
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LoginProfile' => [
        'CreateDate' => <DateTime>,
        'PasswordResetRequired' => true || false,
        'UserName' => '<string>',
    ],
]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->createLoginProfile([
    'Password' => 'h]6EszR}vJ*m',
    'PasswordResetRequired' => 1,
    'UserName' => 'Bob',
]);

Result syntax:

[
    'LoginProfile' => [
        'CreateDate' => ,
        'PasswordResetRequired' => 1,
        'UserName' => 'Bob',
    ],
]

CreateOpenIDConnectProvider

$result = $client->createOpenIDConnectProvider([/* ... */]);
$promise = $client->createOpenIDConnectProviderAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createOpenIDConnectProvider([
    'ClientIDList' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ThumbprintList' => ['<string>', ...],
    'Url' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'OpenIDConnectProviderArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->createOpenIDConnectProvider([
    'ClientIDList' => [
        'my-application-id',
    ],
    'ThumbprintList' => [
        '3768084dfb3d2b68b7897bf5f565da8efEXAMPLE',
    ],
    'Url' => 'https://server.example.com',
]);

Result syntax:

[
    'OpenIDConnectProviderArn' => 'arn:aws:iam::123456789012:oidc-provider/server.example.com',
]

CreatePolicy

$result = $client->createPolicy([/* ... */]);
$promise = $client->createPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createPolicy([
    'Description' => '<string>',
    'Path' => '<string>',
    'PolicyDocument' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Policy' => [
        'Arn' => '<string>',
        'AttachmentCount' => <integer>,
        'CreateDate' => <DateTime>,
        'DefaultVersionId' => '<string>',
        'Description' => '<string>',
        'IsAttachable' => true || false,
        'Path' => '<string>',
        'PermissionsBoundaryUsageCount' => <integer>,
        'PolicyId' => '<string>',
        'PolicyName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdateDate' => <DateTime>,
    ],
]

Result Details

Errors

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.

CreatePolicyVersion

$result = $client->createPolicyVersion([/* ... */]);
$promise = $client->createPolicyVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createPolicyVersion([
    'PolicyArn' => '<string>', // REQUIRED
    'PolicyDocument' => '<string>', // REQUIRED
    'SetAsDefault' => true || false,
]);

Parameter Details

Result Syntax

[
    'PolicyVersion' => [
        'CreateDate' => <DateTime>,
        'Document' => '<string>',
        'IsDefaultVersion' => true || false,
        'VersionId' => '<string>',
    ],
]

Result Details

Errors

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.

CreateRole

$result = $client->createRole([/* ... */]);
$promise = $client->createRoleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createRole([
    'AssumeRolePolicyDocument' => '<string>', // REQUIRED
    'Description' => '<string>',
    'MaxSessionDuration' => <integer>,
    'Path' => '<string>',
    'PermissionsBoundary' => '<string>',
    'RoleName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Role' => [
        'Arn' => '<string>',
        'AssumeRolePolicyDocument' => '<string>',
        'CreateDate' => <DateTime>,
        'Description' => '<string>',
        'MaxSessionDuration' => <integer>,
        'Path' => '<string>',
        'PermissionsBoundary' => [
            'PermissionsBoundaryArn' => '<string>',
            'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
        ],
        'RoleId' => '<string>',
        'RoleLastUsed' => [
            'LastUsedDate' => <DateTime>,
            'Region' => '<string>',
        ],
        'RoleName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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.

Examples

Example 1: To create an IAM role

The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.

$result = $client->createRole([
    'AssumeRolePolicyDocument' => '',
    'Path' => '/',
    'RoleName' => 'Test-Role',
]);

Result syntax:

[
    'Role' => [
        'Arn' => 'arn:aws:iam::123456789012:role/Test-Role',
        'AssumeRolePolicyDocument' => '',
        'CreateDate' => ,
        'Path' => '/',
        'RoleId' => 'AKIAIOSFODNN7EXAMPLE',
        'RoleName' => 'Test-Role',
    ],
]

CreateSAMLProvider

$result = $client->createSAMLProvider([/* ... */]);
$promise = $client->createSAMLProviderAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->createSAMLProvider([
    'Name' => '<string>', // REQUIRED
    'SAMLMetadataDocument' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'SAMLProviderArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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.

CreateServiceLinkedRole

$result = $client->createServiceLinkedRole([/* ... */]);
$promise = $client->createServiceLinkedRoleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createServiceLinkedRole([
    'AWSServiceName' => '<string>', // REQUIRED
    'CustomSuffix' => '<string>',
    'Description' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Role' => [
        'Arn' => '<string>',
        'AssumeRolePolicyDocument' => '<string>',
        'CreateDate' => <DateTime>,
        'Description' => '<string>',
        'MaxSessionDuration' => <integer>,
        'Path' => '<string>',
        'PermissionsBoundary' => [
            'PermissionsBoundaryArn' => '<string>',
            'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
        ],
        'RoleId' => '<string>',
        'RoleLastUsed' => [
            'LastUsedDate' => <DateTime>,
            'Region' => '<string>',
        ],
        'RoleName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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.

CreateServiceSpecificCredential

$result = $client->createServiceSpecificCredential([/* ... */]);
$promise = $client->createServiceSpecificCredentialAsync([/* ... */]);

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about service-specific credentials, see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.

Parameter Syntax

$result = $client->createServiceSpecificCredential([
    'ServiceName' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ServiceSpecificCredential' => [
        'CreateDate' => <DateTime>,
        'ServiceName' => '<string>',
        'ServicePassword' => '<string>',
        'ServiceSpecificCredentialId' => '<string>',
        'ServiceUserName' => '<string>',
        'Status' => 'Active|Inactive',
        'UserName' => '<string>',
    ],
]

Result Details

Errors

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.

ServiceNotSupportedException:

The specified service does not support service-specific credentials.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createUser([
    'Path' => '<string>',
    'PermissionsBoundary' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'Arn' => '<string>',
        'CreateDate' => <DateTime>,
        'PasswordLastUsed' => <DateTime>,
        'Path' => '<string>',
        'PermissionsBoundary' => [
            'PermissionsBoundaryArn' => '<string>',
            'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UserId' => '<string>',
        'UserName' => '<string>',
    ],
]

Result Details

Errors

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.

Examples

Example 1: To create an IAM user

The following create-user command creates an IAM user named Bob in the current account.

$result = $client->createUser([
    'UserName' => 'Bob',
]);

Result syntax:

[
    'User' => [
        'Arn' => 'arn:aws:iam::123456789012:user/Bob',
        'CreateDate' => ,
        'Path' => '/',
        'UserId' => 'AKIAIOSFODNN7EXAMPLE',
        'UserName' => 'Bob',
    ],
]

CreateVirtualMFADevice

$result = $client->createVirtualMFADevice([/* ... */]);
$promise = $client->createVirtualMFADeviceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createVirtualMFADevice([
    'Path' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VirtualMFADeviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VirtualMFADevice' => [
        'Base32StringSeed' => <string || resource || Psr\Http\Message\StreamInterface>,
        'EnableDate' => <DateTime>,
        'QRCodePNG' => <string || resource || Psr\Http\Message\StreamInterface>,
        'SerialNumber' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'User' => [
            'Arn' => '<string>',
            'CreateDate' => <DateTime>,
            'PasswordLastUsed' => <DateTime>,
            'Path' => '<string>',
            'PermissionsBoundary' => [
                'PermissionsBoundaryArn' => '<string>',
                'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UserId' => '<string>',
            'UserName' => '<string>',
        ],
    ],
]

Result Details

Errors

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.

DeactivateMFADevice

$result = $client->deactivateMFADevice([/* ... */]);
$promise = $client->deactivateMFADeviceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deactivateMFADevice([
    'SerialNumber' => '<string>', // REQUIRED
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteAccessKey

$result = $client->deleteAccessKey([/* ... */]);
$promise = $client->deleteAccessKeyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAccessKey([
    'AccessKeyId' => '<string>', // REQUIRED
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: 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.

$result = $client->deleteAccessKey([
    'AccessKeyId' => 'AKIDPMS9RO4H3FEXAMPLE',
    'UserName' => 'Bob',
]);

DeleteAccountAlias

$result = $client->deleteAccountAlias([/* ... */]);
$promise = $client->deleteAccountAliasAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAccountAlias([
    'AccountAlias' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete an account alias

The following command removes the alias mycompany from the current AWS account:

$result = $client->deleteAccountAlias([
    'AccountAlias' => 'mycompany',
]);

DeleteAccountPasswordPolicy

$result = $client->deleteAccountPasswordPolicy([/* ... */]);
$promise = $client->deleteAccountPasswordPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteAccountPasswordPolicy([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete the current account password policy

The following command removes the password policy from the current AWS account:

$result = $client->deleteAccountPasswordPolicy([
]);

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteGroup([
    'GroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteGroupPolicy

$result = $client->deleteGroupPolicy([/* ... */]);
$promise = $client->deleteGroupPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteGroupPolicy([
    'GroupName' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete a policy from an IAM group

The following command deletes the policy named ExamplePolicy from the group named Admins:

$result = $client->deleteGroupPolicy([
    'GroupName' => 'Admins',
    'PolicyName' => 'ExamplePolicy',
]);

DeleteInstanceProfile

$result = $client->deleteInstanceProfile([/* ... */]);
$promise = $client->deleteInstanceProfileAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteInstanceProfile([
    'InstanceProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete an instance profile

The following command deletes the instance profile named ExampleInstanceProfile

$result = $client->deleteInstanceProfile([
    'InstanceProfileName' => 'ExampleInstanceProfile',
]);

DeleteLoginProfile

$result = $client->deleteLoginProfile([/* ... */]);
$promise = $client->deleteLoginProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteLoginProfile([
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete a password for an IAM user

The following command deletes the password for the IAM user named Bob.

$result = $client->deleteLoginProfile([
    'UserName' => 'Bob',
]);

DeleteOpenIDConnectProvider

$result = $client->deleteOpenIDConnectProvider([/* ... */]);
$promise = $client->deleteOpenIDConnectProviderAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteOpenIDConnectProvider([
    'OpenIDConnectProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeletePolicy

$result = $client->deletePolicy([/* ... */]);
$promise = $client->deletePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deletePolicy([
    'PolicyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeletePolicyVersion

$result = $client->deletePolicyVersion([/* ... */]);
$promise = $client->deletePolicyVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deletePolicyVersion([
    'PolicyArn' => '<string>', // REQUIRED
    'VersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteRole

$result = $client->deleteRole([/* ... */]);
$promise = $client->deleteRoleAsync([/* ... */]);

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:

• Inline policies (DeleteRolePolicy)

• Attached managed policies (DetachRolePolicy)

• Instance profile (RemoveRoleFromInstanceProfile)

• Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)

Parameter Syntax

$result = $client->deleteRole([
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete an IAM role

The following command removes the role named Test-Role.

$result = $client->deleteRole([
    'RoleName' => 'Test-Role',
]);

DeleteRolePermissionsBoundary

$result = $client->deleteRolePermissionsBoundary([/* ... */]);
$promise = $client->deleteRolePermissionsBoundaryAsync([/* ... */]);

Deletes the permissions boundary for the specified IAM role.

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

Parameter Syntax

$result = $client->deleteRolePermissionsBoundary([
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteRolePolicy

$result = $client->deleteRolePolicy([/* ... */]);
$promise = $client->deleteRolePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteRolePolicy([
    'PolicyName' => '<string>', // REQUIRED
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To remove a policy from an IAM role

The following command removes the policy named ExamplePolicy from the role named Test-Role.

$result = $client->deleteRolePolicy([
    'PolicyName' => 'ExamplePolicy',
    'RoleName' => 'Test-Role',
]);

DeleteSAMLProvider

$result = $client->deleteSAMLProvider([/* ... */]);
$promise = $client->deleteSAMLProviderAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteSAMLProvider([
    'SAMLProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteSSHPublicKey

$result = $client->deleteSSHPublicKey([/* ... */]);
$promise = $client->deleteSSHPublicKeyAsync([/* ... */]);

Deletes the specified SSH public key.

The SSH public key deleted 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.

Parameter Syntax

$result = $client->deleteSSHPublicKey([
    'SSHPublicKeyId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchEntityException:

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

DeleteServerCertificate

$result = $client->deleteServerCertificate([/* ... */]);
$promise = $client->deleteServerCertificateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteServerCertificate([
    'ServerCertificateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteServiceLinkedRole

$result = $client->deleteServiceLinkedRole([/* ... */]);
$promise = $client->deleteServiceLinkedRoleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteServiceLinkedRole([
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DeletionTaskId' => '<string>',
]

Result Details

Errors

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.

DeleteServiceSpecificCredential

$result = $client->deleteServiceSpecificCredential([/* ... */]);
$promise = $client->deleteServiceSpecificCredentialAsync([/* ... */]);

Deletes the specified service-specific credential.

Parameter Syntax

$result = $client->deleteServiceSpecificCredential([
    'ServiceSpecificCredentialId' => '<string>', // REQUIRED
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchEntityException:

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

DeleteSigningCertificate

$result = $client->deleteSigningCertificate([/* ... */]);
$promise = $client->deleteSigningCertificateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteSigningCertificate([
    'CertificateId' => '<string>', // REQUIRED
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete a signing certificate for an IAM user

The following command deletes the specified signing certificate for the IAM user named Anika.

$result = $client->deleteSigningCertificate([
    'CertificateId' => 'TA7SMP42TDN5Z26OBPJE7EXAMPLE',
    'UserName' => 'Anika',
]);

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

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:

• Password (DeleteLoginProfile)

• Access keys (DeleteAccessKey)

• Signing certificate (DeleteSigningCertificate)

• SSH public key (DeleteSSHPublicKey)

• Git credentials (DeleteServiceSpecificCredential)

• Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)

• Inline policies (DeleteUserPolicy)

• Attached managed policies (DetachUserPolicy)

• Group memberships (RemoveUserFromGroup)

Parameter Syntax

$result = $client->deleteUser([
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To delete an IAM user

The following command removes the IAM user named Bob from the current account.

$result = $client->deleteUser([
    'UserName' => 'Bob',
]);

DeleteUserPermissionsBoundary

$result = $client->deleteUserPermissionsBoundary([/* ... */]);
$promise = $client->deleteUserPermissionsBoundaryAsync([/* ... */]);

Deletes the permissions boundary for the specified IAM user.

Parameter Syntax

$result = $client->deleteUserPermissionsBoundary([
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DeleteUserPolicy

$result = $client->deleteUserPolicy([/* ... */]);
$promise = $client->deleteUserPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteUserPolicy([
    'PolicyName' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To remove a policy from an IAM user

The following delete-user-policy command removes the specified policy from the IAM user named Juan:

$result = $client->deleteUserPolicy([
    'PolicyName' => 'ExamplePolicy',
    'UserName' => 'Juan',
]);

DeleteVirtualMFADevice

$result = $client->deleteVirtualMFADevice([/* ... */]);
$promise = $client->deleteVirtualMFADeviceAsync([/* ... */]);

Deletes a virtual MFA device.

Parameter Syntax

$result = $client->deleteVirtualMFADevice([
    'SerialNumber' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

Examples

Example 1: To remove a virtual MFA device

The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.

$result = $client->deleteVirtualMFADevice([
    'SerialNumber' => 'arn:aws:iam::123456789012:mfa/ExampleName',
]);

DetachGroupPolicy

$result = $client->detachGroupPolicy([/* ... */]);
$promise = $client->detachGroupPolicyAsync([/* ... */]);

Removes the specified managed policy from the specified IAM group.

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

Parameter Syntax

$result = $client->detachGroupPolicy([
    'GroupName' => '<string>', // REQUIRED
    'PolicyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

ServiceFailureException:

The request processing has failed because of an unknown error, exception or failure.

DetachRolePolicy

$result = $client->detachRolePolicy([/* ... */]);
$promise = $client->detachRolePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->detachRolePolicy([
    'PolicyArn' => '<string>', // REQUIRED
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

DetachUserPolicy

$result = $client->detachUserPolicy([/* ... */]);
$promise = $client->detachUserPolicyAsync([/* ... */]);

Removes the specified managed policy from the specified user.

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

Parameter Syntax

$result = $client->detachUserPolicy([
    'PolicyArn' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

ServiceFailureException:

The request processing has failed because of an unknown error, exception or failure.

DisableOrganizationsRootCredentialsManagement

$result = $client->disableOrganizationsRootCredentialsManagement([/* ... */]);
$promise = $client->disableOrganizationsRootCredentialsManagementAsync([/* ... */]);

Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated admininstrator for IAM can no longer manage root user credentials for member accounts in your organization.

Parameter Syntax

$result = $client->disableOrganizationsRootCredentialsManagement([
]);

Parameter Details

Result Syntax

[
    'EnabledFeatures' => ['<string>', ...],
    'OrganizationId' => '<string>',
]

Result Details

Errors

ServiceAccessNotEnabledException:

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

AccountNotManagementOrDelegatedAdministratorException:

The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.

OrganizationNotFoundException:

The request was rejected because no organization is associated with your account.

OrganizationNotInAllFeaturesModeException:

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

Examples

Example 1: To disable the RootCredentialsManagement feature in your organization

The following command disables the management of privileged root user credentials across member accounts in your organization.

$result = $client->disableOrganizationsRootCredentialsManagement([
]);

Result syntax:

[
    'EnabledFeatures' => [
        'RootSessions',
    ],
    'OrganizationId' => 'o-aa111bb222',
]

DisableOrganizationsRootSessions

$result = $client->disableOrganizationsRootSessions([/* ... */]);
$promise = $client->disableOrganizationsRootSessionsAsync([/* ... */]);

Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated admininstrator for IAM can no longer perform privileged tasks on member accounts in your organization.

Parameter Syntax

$result = $client->disableOrganizationsRootSessions([
]);

Parameter Details

Result Syntax

[
    'EnabledFeatures' => ['<string>', ...],
    'OrganizationId' => '<string>',
]

Result Details

Errors

ServiceAccessNotEnabledException:

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

AccountNotManagementOrDelegatedAdministratorException:

The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.

OrganizationNotFoundException:

The request was rejected because no organization is associated with your account.

OrganizationNotInAllFeaturesModeException:

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

Examples

Example 1: To disable the RootSessions feature in your organization

The following command disables root user sessions for privileged tasks across member accounts in your organization.

$result = $client->disableOrganizationsRootSessions([
]);

Result syntax:

[
    'EnabledFeatures' => [
        'RootCredentialsManagement',
    ],
    'OrganizationId' => 'o-aa111bb222',
]

EnableMFADevice

$result = $client->enableMFADevice([/* ... */]);
$promise = $client->enableMFADeviceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->enableMFADevice([
    'AuthenticationCode1' => '<string>', // REQUIRED
    'AuthenticationCode2' => '<string>', // REQUIRED
    'SerialNumber' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

EnableOrganizationsRootCredentialsManagement

$result = $client->enableOrganizationsRootCredentialsManagement([/* ... */]);
$promise = $client->enableOrganizationsRootCredentialsManagementAsync([/* ... */]);

Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for centralized root access, the management account and the delegated admininstrator for IAM can manage root user credentials for member accounts in your organization.

Before you enable centralized root access, you must have an account configured with the following settings:

• You must manage your Amazon Web Services accounts in Organizations.

• Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

Parameter Syntax

$result = $client->enableOrganizationsRootCredentialsManagement([
]);

Parameter Details

Result Syntax

[
    'EnabledFeatures' => ['<string>', ...],
    'OrganizationId' => '<string>',
]

Result Details

Errors

ServiceAccessNotEnabledException:

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

AccountNotManagementOrDelegatedAdministratorException:

The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.

OrganizationNotFoundException:

The request was rejected because no organization is associated with your account.

OrganizationNotInAllFeaturesModeException:

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

CallerIsNotManagementAccountException:

The request was rejected because the account making the request is not the management account for the organization.

Examples

Example 1: To enable the RootCredentialsManagement feature in your organization

The following command enables the management of privileged root user credentials across member accounts in your organization.

$result = $client->enableOrganizationsRootCredentialsManagement([
]);

Result syntax:

[
    'EnabledFeatures' => [
        'RootCredentialsManagement',
    ],
    'OrganizationId' => 'o-aa111bb222',
]

EnableOrganizationsRootSessions

$result = $client->enableOrganizationsRootSessions([/* ... */]);
$promise = $client->enableOrganizationsRootSessionsAsync([/* ... */]);

Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management User Guide.

Before you enable this feature, you must have an account configured with the following settings:

• You must manage your Amazon Web Services accounts in Organizations.

• Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

Parameter Syntax

$result = $client->enableOrganizationsRootSessions([
]);

Parameter Details

Result Syntax

[
    'EnabledFeatures' => ['<string>', ...],
    'OrganizationId' => '<string>',
]

Result Details

Errors

ServiceAccessNotEnabledException:

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

AccountNotManagementOrDelegatedAdministratorException:

The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.

OrganizationNotFoundException:

The request was rejected because no organization is associated with your account.

OrganizationNotInAllFeaturesModeException:

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

CallerIsNotManagementAccountException:

The request was rejected because the account making the request is not the management account for the organization.

Examples

Example 1: To enable the RootSessions feature in your organization

The following command allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization.

$result = $client->enableOrganizationsRootSessions([
]);

Result syntax:

[
    'EnabledFeatures' => [
        'RootCredentialsManagement',
        'RootSessions',
    ],
    'OrganizationId' => 'o-aa111bb222',
]

GenerateCredentialReport

$result = $client->generateCredentialReport([/* ... */]);
$promise = $client->generateCredentialReportAsync([/* ... */]);

Generates a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

Parameter Syntax

$result = $client->generateCredentialReport([
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'State' => 'STARTED|INPROGRESS|COMPLETE',
]

Result Details

Errors

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.

GenerateOrganizationsAccessReport

$result = $client->generateOrganizationsAccessReport([/* ... */]);
$promise = $client->generateOrganizationsAccessReportAsync([/* ... */]);

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.

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.

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

Parameter Syntax

$result = $client->generateOrganizationsAccessReport([
    'EntityPath' => '<string>', // REQUIRED
    'OrganizationsPolicyId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Errors

ReportGenerationLimitExceededException:

The request failed because the maximum number of concurrent requests for this account are already running.

Examples

Example 1: To generate a service last accessed data report for an organizational unit

The following operation generates a report for the organizational unit ou-rge0-awexample

$result = $client->generateOrganizationsAccessReport([
    'EntityPath' => 'o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example',
]);

Result syntax:

[
    'JobId' => 'examplea-1234-b567-cde8-90fg123abcd4',
]

GenerateServiceLastAccessedDetails

$result = $client->generateServiceLastAccessedDetails([/* ... */]);
$promise = $client->generateServiceLastAccessedDetailsAsync([/* ... */]);

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 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.

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

Parameter Syntax

$result = $client->generateServiceLastAccessedDetails([
    'Arn' => '<string>', // REQUIRED
    'Granularity' => 'SERVICE_LEVEL|ACTION_LEVEL',
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Errors

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.

Examples

Example 1: To generate a service last accessed data report for a policy

The following operation generates a report for the policy: ExamplePolicy1

$result = $client->generateServiceLastAccessedDetails([
    'Arn' => 'arn:aws:iam::123456789012:policy/ExamplePolicy1',
]);

Result syntax:

[
    'JobId' => 'examplef-1305-c245-eba4-71fe298bcda7',
]

GetAccessKeyLastUsed

$result = $client->getAccessKeyLastUsed([/* ... */]);
$promise = $client->getAccessKeyLastUsedAsync([/* ... */]);

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key.

Parameter Syntax

$result = $client->getAccessKeyLastUsed([
    'AccessKeyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessKeyLastUsed' => [
        'LastUsedDate' => <DateTime>,
        'Region' => '<string>',
        'ServiceName' => '<string>',
    ],
    'UserName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetAccountAuthorizationDetails

$result = $client->getAccountAuthorizationDetails([/* ... */]);
$promise = $client->getAccountAuthorizationDetailsAsync([/* ... */]);

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.

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

Parameter Syntax

$result = $client->getAccountAuthorizationDetails([
    'Filter' => ['<string>', ...],
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Result Syntax

[
    'GroupDetailList' => [
        [
            'Arn' => '<string>',
            'AttachedManagedPolicies' => [
                [
                    'PolicyArn' => '<string>',
                    'PolicyName' => '<string>',
                ],
                // ...
            ],
            'CreateDate' => <DateTime>,
            'GroupId' => '<string>',
            'GroupName' => '<string>',
            'GroupPolicyList' => [
                [
                    'PolicyDocument' => '<string>',
                    'PolicyName' => '<string>',
                ],
                // ...
            ],
            'Path' => '<string>',
        ],
        // ...
    ],
    'IsTruncated' => true || false,
    'Marker' => '<string>',
    'Policies' => [
        [
            'Arn' => '<string>',
            'AttachmentCount' => <integer>,
            'CreateDate' => <DateTime>,
            'DefaultVersionId' => '<string>',
            'Description' => '<string>',
            'IsAttachable' => true || false,
            'Path' => '<string>',
            'PermissionsBoundaryUsageCount' => <integer>,
            'PolicyId' => '<string>',
            'PolicyName' => '<string>',
            'PolicyVersionList' => [
                [
                    'CreateDate' => <DateTime>,
                    'Document' => '<string>',
                    'IsDefaultVersion' => true || false,
                    'VersionId' => '<string>',
                ],
                // ...
            ],
            'UpdateDate' => <DateTime>,
        ],
        // ...
    ],
    'RoleDetailList' => [
        [
            'Arn' => '<string>',
            'AssumeRolePolicyDocument' => '<string>',
            'AttachedManagedPolicies' => [
                [
                    'PolicyArn' => '<string>',
                    'PolicyName' => '<string>',
                ],
                // ...
            ],
            'CreateDate' => <DateTime>,
            'InstanceProfileList' => [
                [
                    'Arn' => '<string>',
                    'CreateDate' => <DateTime>,
                    'InstanceProfileId' => '<string>',
                    'InstanceProfileName' => '<string>',
                    'Path' => '<string>',
                    'Roles' => [
                        [
                            'Arn' => '<string>',
                            'AssumeRolePolicyDocument' => '<string>',
                            'CreateDate' => <DateTime>,
                            'Description' => '<string>',
                            'MaxSessionDuration' => <integer>,
                            'Path' => '<string>',
                            'PermissionsBoundary' => [
                                'PermissionsBoundaryArn' => '<string>',
                                'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
                            ],
                            'RoleId' => '<string>',
                            'RoleLastUsed' => [
                                'LastUsedDate' => <DateTime>,
                                'Region' => '<string>',
                            ],
                            'RoleName' => '<string>',
                            'Tags' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Path' => '<string>',
            'PermissionsBoundary' => [
                'PermissionsBoundaryArn' => '<string>',
                'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
            ],
            'RoleId' => '<string>',
            'RoleLastUsed' => [
                'LastUsedDate' => <DateTime>,
                'Region' => '<string>',
            ],
            'RoleName' => '<string>',
            'RolePolicyList' => [
                [
                    'PolicyDocument' => '<string>',
                    'PolicyName' => '<string>',
                ],
                // ...
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'UserDetailList' => [
        [
            'Arn' => '<string>',
            'AttachedManagedPolicies' => [
                [
                    'PolicyArn' => '<string>',
                    'PolicyName' => '<string>',
                ],
                // ...
            ],
            'CreateDate' => <DateTime>,
            'GroupList' => ['<string>', ...],
            'Path' => '<string>',
            'PermissionsBoundary' => [
                'PermissionsBoundaryArn' => '<string>',
                'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UserId' => '<string>',
            'UserName' => '<string>',
            'UserPolicyList' => [
                [
                    'PolicyDocument' => '<string>',
                    'PolicyName' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ServiceFailureException:

The request processing has failed because of an unknown error, exception or failure.

GetAccountPasswordPolicy

$result = $client->getAccountPasswordPolicy([/* ... */]);
$promise = $client->getAccountPasswordPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAccountPasswordPolicy([
]);

Parameter Details

Result Syntax

[
    'PasswordPolicy' => [
        'AllowUsersToChangePassword' => true || false,
        'ExpirePasswords' => true || false,
        'HardExpiry' => true || false,
        'MaxPasswordAge' => <integer>,
        'MinimumPasswordLength' => <integer>,
        'PasswordReusePrevention' => <integer>,
        'RequireLowercaseCharacters' => true || false,
        'RequireNumbers' => true || false,
        'RequireSymbols' => true || false,
        'RequireUppercaseCharacters' => true || false,
    ],
]

Result Details

Errors

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.

Examples

Example 1: To see the current account password policy

The following command displays details about the password policy for the current AWS account.

$result = $client->getAccountPasswordPolicy([
]);

Result syntax:

[
    'PasswordPolicy' => [
        'AllowUsersToChangePassword' => ,
        'ExpirePasswords' => ,
        'HardExpiry' => ,
        'MaxPasswordAge' => 90,
        'MinimumPasswordLength' => 8,
        'PasswordReusePrevention' => 12,
        'RequireLowercaseCharacters' => ,
        'RequireNumbers' => 1,
        'RequireSymbols' => 1,
        'RequireUppercaseCharacters' => ,
    ],
]

GetAccountSummary

$result = $client->getAccountSummary([/* ... */]);
$promise = $client->getAccountSummaryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAccountSummary([
]);

Parameter Details

Result Syntax

[
    'SummaryMap' => [<integer>, ...],
]

Result Details

Errors

ServiceFailureException:

The request processing has failed because of an unknown error, exception or failure.

Examples

Example 1: 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.

$result = $client->getAccountSummary([
]);

Result syntax:

[
    'SummaryMap' => [
        'AccessKeysPerUserQuota' => 2,
        'AccountAccessKeysPresent' => 1,
        'AccountMFAEnabled' => 0,
        'AccountSigningCertificatesPresent' => 0,
        'AttachedPoliciesPerGroupQuota' => 10,
        'AttachedPoliciesPerRoleQuota' => 10,
        'AttachedPoliciesPerUserQuota' => 10,
        'GlobalEndpointTokenVersion' => 2,
        'GroupPolicySizeQuota' => 5120,
        'Groups' => 15,
        'GroupsPerUserQuota' => 10,
        'GroupsQuota' => 100,
        'MFADevices' => 6,
        'MFADevicesInUse' => 3,
        'Policies' => 8,
        'PoliciesQuota' => 1000,
        'PolicySizeQuota' => 5120,
        'PolicyVersionsInUse' => 22,
        'PolicyVersionsInUseQuota' => 10000,
        'ServerCertificates' => 1,
        'ServerCertificatesQuota' => 20,
        'SigningCertificatesPerUserQuota' => 2,
        'UserPolicySizeQuota' => 2048,
        'Users' => 27,
        'UsersQuota' => 5000,
        'VersionsPerPolicyQuota' => 5,
    ],
]

GetContextKeysForCustomPolicy

$result = $client->getContextKeysForCustomPolicy([/* ... */]);
$promise = $client->getContextKeysForCustomPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getContextKeysForCustomPolicy([
    'PolicyInputList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContextKeyNames' => ['<string>', ...],
]

Result Details

Errors

InvalidInputException:

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

GetContextKeysForPrincipalPolicy

$result = $client->getContextKeysForPrincipalPolicy([/* ... */]);
$promise = $client->getContextKeysForPrincipalPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getContextKeysForPrincipalPolicy([
    'PolicyInputList' => ['<string>', ...],
    'PolicySourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContextKeyNames' => ['<string>', ...],
]

Result Details

Errors

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.

GetCredentialReport

$result = $client->getCredentialReport([/* ... */]);
$promise = $client->getCredentialReportAsync([/* ... */]);

Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

Parameter Syntax

$result = $client->getCredentialReport([
]);

Parameter Details

Result Syntax

[
    'Content' => <string || resource || Psr\Http\Message\StreamInterface>,
    'GeneratedTime' => <DateTime>,
    'ReportFormat' => 'text/csv',
]

Result Details

Errors

CredentialReportNotPresentException:

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

CredentialReportExpiredException:

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting credential reports in the IAM User Guide.

CredentialReportNotReadyException:

The request was rejected because the credential report is still being generated.

ServiceFailureException:

The request processing has failed because of an unknown error, exception or failure.

GetGroup

$result = $client->getGroup([/* ... */]);
$promise = $client->getGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getGroup([
    'GroupName' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'Arn' => '<string>',
        'CreateDate' => <DateTime>,
        'GroupId' => '<string>',
        'GroupName' => '<string>',
        'Path' => '<string>',
    ],
    'IsTruncated' => true || false,
    'Marker' => '<string>',
    'Users' => [
        [
            'Arn' => '<string>',
            'CreateDate' => <DateTime>,
            'PasswordLastUsed' => <DateTime>,
            'Path' => '<string>',
            'PermissionsBoundary' => [
                'PermissionsBoundaryArn' => '<string>',
                'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UserId' => '<string>',
            'UserName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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.

GetGroupPolicy

$result = $client->getGroupPolicy([/* ... */]);
$promise = $client->getGroupPolicyAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->getGroupPolicy([
    'GroupName' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupName' => '<string>',
    'PolicyDocument' => '<string>',
    'PolicyName' => '<string>',
]

Result Details

Errors

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.

GetInstanceProfile

$result = $client->getInstanceProfile([/* ... */]);
$promise = $client->getInstanceProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getInstanceProfile([
    'InstanceProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InstanceProfile' => [
        'Arn' => '<string>',
        'CreateDate' => <DateTime>,
        'InstanceProfileId' => '<string>',
        'InstanceProfileName' => '<string>',
        'Path' => '<string>',
        'Roles' => [
            [
                'Arn' => '<string>',
                'AssumeRolePolicyDocument' => '<string>',
                'CreateDate' => <DateTime>,
                'Description' => '<string>',
                'MaxSessionDuration' => <integer>,
                'Path' => '<string>',
                'PermissionsBoundary' => [
                    'PermissionsBoundaryArn' => '<string>',
                    'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
                ],
                'RoleId' => '<string>',
                'RoleLastUsed' => [
                    'LastUsedDate' => <DateTime>,
                    'Region' => '<string>',
                ],
                'RoleName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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.

Examples

Example 1: To get information about an instance profile

The following command gets information about the instance profile named ExampleInstanceProfile.

$result = $client->getInstanceProfile([
    'InstanceProfileName' => 'ExampleInstanceProfile',
]);

Result syntax:

[
    'InstanceProfile' => [
        'Arn' => 'arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile',
        'CreateDate' => ,
        'InstanceProfileId' => 'AID2MAB8DPLSRHEXAMPLE',
        'InstanceProfileName' => 'ExampleInstanceProfile',
        'Path' => '/',
        'Roles' => [
            [
                'Arn' => 'arn:aws:iam::336924118301:role/Test-Role',
                'AssumeRolePolicyDocument' => '',
                'CreateDate' => ,
                'Path' => '/',
                'RoleId' => 'AIDGPMS9RO4H3FEXAMPLE',
                'RoleName' => 'Test-Role',
            ],
        ],
    ],
]

GetLoginProfile

$result = $client->getLoginProfile([/* ... */]);
$promise = $client->getLoginProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getLoginProfile([
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LoginProfile' => [
        'CreateDate' => <DateTime>,
        'PasswordResetRequired' => true || false,
        'UserName' => '<string>',
    ],
]

Result Details

Errors

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.

Examples

Example 1: To get password information for an IAM user

The following command gets information about the password for the IAM user named Anika.

$result = $client->getLoginProfile([
    'UserName' => 'Anika',
]);

Result syntax:

[
    'LoginProfile' => [
        'CreateDate' => ,
        'UserName' => 'Anika',
    ],
]

GetMFADevice

$result = $client->getMFADevice([/* ... */]);
$promise = $client->getMFADeviceAsync([/* ... */]);

Retrieves information about an MFA device for a specified user.

Parameter Syntax

$result = $client->getMFADevice([
    'SerialNumber' => '<string>', // REQUIRED
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Certifications' => ['<string>', ...],
    'EnableDate' => <DateTime>,
    'SerialNumber' => '<string>',
    'UserName' => '<string>',
]

Result Details

Errors

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.

GetOpenIDConnectProvider

$result = $client->getOpenIDConnectProvider([/* ... */]);
$promise = $client->getOpenIDConnectProviderAsync([/* ... */]);

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

Parameter Syntax

$result = $client->getOpenIDConnectProvider([
    'OpenIDConnectProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ClientIDList' => ['<string>', ...],
    'CreateDate' => <DateTime>,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ThumbprintList' => ['<string>', ...],
    'Url' => '<string>',
]

Result Details

Errors

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.

GetOrganizationsAccessReport

$result = $client->getOrganizationsAccessReport([/* ... */]);
$promise = $client->getOrganizationsAccessReportAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getOrganizationsAccessReport([
    'JobId' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'SortKey' => 'SERVICE_NAMESPACE_ASCENDING|SERVICE_NAMESPACE_DESCENDING|LAST_AUTHENTICATED_TIME_ASCENDING|LAST_AUTHENTICATED_TIME_DESCENDING',
]);

Parameter Details

Result Syntax

[
    'AccessDetails' => [
        [
            'EntityPath' => '<string>',
            'LastAuthenticatedTime' => <DateTime>,
            'Region' => '<string>',
            'ServiceName' => '<string>',
            'ServiceNamespace' => '<string>',
            'TotalAuthenticatedEntities' => <integer>,
        ],
        // ...
    ],
    'ErrorDetails' => [
        'Code' => '<string>',
        'Message' => '<string>',
    ],
    'IsTruncated' => true || false,
    'JobCompletionDate' => <DateTime>,
    'JobCreationDate' => <DateTime>,
    'JobStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
    'Marker' => '<string>',
    'NumberOfServicesAccessible' => <integer>,
    'NumberOfServicesNotAccessed' => <integer>,
]

Result Details

Errors

NoSuchEntityException:

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Examples

Example 1: To get details from a previously generated organizational unit report

The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4

$result = $client->getOrganizationsAccessReport([
    'JobId' => 'examplea-1234-b567-cde8-90fg123abcd4',
]);

Result syntax:

[
    'AccessDetails' => [
        [
            'EntityPath' => 'o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333',
            'LastAuthenticatedTime' => ,
            'Region' => 'us-east-1',
            'ServiceName' => 'Amazon DynamoDB',
            'ServiceNamespace' => 'dynamodb',
            'TotalAuthenticatedEntities' => 2,
        ],
        [
            'EntityPath' => 'o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012',
            'LastAuthenticatedTime' => ,
            'Region' => 'us-east-1',
            'ServiceName' => 'AWS Identity and Access Management',
            'ServiceNamespace' => 'iam',
            'TotalAuthenticatedEntities' => 4,
        ],
        [
            'ServiceName' => 'Amazon Simple Storage Service',
            'ServiceNamespace' => 's3',
            'TotalAuthenticatedEntities' => 0,
        ],
    ],
    'IsTruncated' => ,
    'JobCompletionDate' => ,
    'JobCreationDate' => ,
    'JobStatus' => 'COMPLETED',
    'NumberOfServicesAccessible' => 3,
    'NumberOfServicesNotAccessed' => 1,
]

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getPolicy([
    'PolicyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => [
        'Arn' => '<string>',
        'AttachmentCount' => <integer>,
        'CreateDate' => <DateTime>,
        'DefaultVersionId' => '<string>',
        'Description' => '<string>',
        'IsAttachable' => true || false,
        'Path' => '<string>',
        'PermissionsBoundaryUsageCount' => <integer>,
        'PolicyId' => '<string>',
        'PolicyName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdateDate' => <DateTime>,
    ],
]

Result Details

Errors

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.

GetPolicyVersion

$result = $client->getPolicyVersion([/* ... */]);
$promise = $client->getPolicyVersionAsync([/* ... */]);

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

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

This 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.

Parameter Syntax

$result = $client->getPolicyVersion([
    'PolicyArn' => '<string>', // REQUIRED
    'VersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PolicyVersion' => [
        'CreateDate' => <DateTime>,
        'Document' => '<string>',
        'IsDefaultVersion' => true || false,
        'VersionId' => '<string>',
    ],
]

Result Details

Errors

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.

GetRole

$result = $client->getRole([/* ... */]);
$promise = $client->getRoleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getRole([
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Role' => [
        'Arn' => '<string>',
        'AssumeRolePolicyDocument' => '<string>',
        'CreateDate' => <DateTime>,
        'Description' => '<string>',
        'MaxSessionDuration' => <integer>,
        'Path' => '<string>',
        'PermissionsBoundary' => [
            'PermissionsBoundaryArn' => '<string>',
            'PermissionsBoundaryType' => 'PermissionsBoundaryPolicy',
        ],
        'RoleId' => '<string>',
        'RoleLastUsed' => [
            'LastUsedDate' => <DateTime>,
            'Region' => '<string>',
        ],
        'RoleName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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.

Examples

Example 1: To get information about an IAM role

The following command gets information about the role named Test-Role.

$result = $client->getRole([
    'RoleName' => 'Test-Role',
]);

Result syntax:

[
    'Role' => [
        'Arn' => 'arn:aws:iam::123456789012:role/Test-Role',
        'AssumeRolePolicyDocument' => '',
        'CreateDate' => ,
        'MaxSessionDuration' => 3600,
        'Path' => '/',
        'RoleId' => 'AROADBQP57FF2AEXAMPLE',
        'RoleLastUsed' => [
            'LastUsedDate' => ,
            'Region' => 'us-east-1',
        ],
        'RoleName' => 'Test-Role',
    ],
]

GetRolePolicy

$result = $client->getRolePolicy([/* ... */]);
$promise = $client->getRolePolicyAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->getRolePolicy([
    'PolicyName' => '<string>', // REQUIRED
    'RoleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PolicyDocument' => '<string>',
    'PolicyName' => '<string>',
    'RoleName' => '<string>',
]

Result Details