使用 SDK for IAM 的 PHP 範例

下列程式碼範例示範如何使用 AWS SDK for PHP 搭配 IAM 來執行動作和實作常見案例。

基本概念是程式碼範例，示範如何在服務中執行基本操作。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會示範如何呼叫個別服務函數，但您可以在其相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

基本概念
動作

基本概念

下列程式碼範例示範如何建立使用者並擔任角色。

警告

為了避免安全風險，開發專用軟體或使用真實資料時，請勿使用 IAM 使用者進行身分驗證。相反地，搭配使用聯合功能和身分提供者，例如 AWS IAM Identity Center。

建立沒有許可的使用者。
建立一個可授予許可的角色，以列出帳戶的 Amazon S3 儲存貯體。
新增政策，讓使用者擔任該角色。
使用暫時憑證，擔任角色並列出 Amazon S3 儲存貯體，然後清理資源。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


namespace Iam\Basics;

require 'vendor/autoload.php';

use Aws\Credentials\Credentials;
use Aws\S3\Exception\S3Exception;
use Aws\S3\S3Client;
use Aws\Sts\StsClient;
use Iam\IAMService;

echo("\n");
echo("--------------------------------------\n");
print("Welcome to the IAM getting started demo using PHP!\n");
echo("--------------------------------------\n");

$uuid = uniqid();
$service = new IAMService();

$user = $service->createUser("iam_demo_user_$uuid");
echo "Created user with the arn: {$user['Arn']}\n";

$key = $service->createAccessKey($user['UserName']);
$assumeRolePolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Principal\": {\"AWS\": \"{$user['Arn']}\"},
                    \"Action\": \"sts:AssumeRole\"
                }]
            }";
$assumeRoleRole = $service->createRole("iam_demo_role_$uuid", $assumeRolePolicyDocument);
echo "Created role: {$assumeRoleRole['RoleName']}\n";

$listAllBucketsPolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Action\": \"s3:ListAllMyBuckets\",
                    \"Resource\": \"arn:aws:s3:::*\"}]
}";
$listAllBucketsPolicy = $service->createPolicy("iam_demo_policy_$uuid", $listAllBucketsPolicyDocument);
echo "Created policy: {$listAllBucketsPolicy['PolicyName']}\n";

$service->attachRolePolicy($assumeRoleRole['RoleName'], $listAllBucketsPolicy['Arn']);

$inlinePolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Action\": \"sts:AssumeRole\",
                    \"Resource\": \"{$assumeRoleRole['Arn']}\"}]
}";
$inlinePolicy = $service->createUserPolicy("iam_demo_inline_policy_$uuid", $inlinePolicyDocument, $user['UserName']);
//First, fail to list the buckets with the user
$credentials = new Credentials($key['AccessKeyId'], $key['SecretAccessKey']);
$s3Client = new S3Client(['region' => 'us-west-2', 'version' => 'latest', 'credentials' => $credentials]);
try {
    $s3Client->listBuckets([
    ]);
    echo "this should not run";
} catch (S3Exception $exception) {
    echo "successfully failed!\n";
}

$stsClient = new StsClient(['region' => 'us-west-2', 'version' => 'latest', 'credentials' => $credentials]);
sleep(10);
$assumedRole = $stsClient->assumeRole([
    'RoleArn' => $assumeRoleRole['Arn'],
    'RoleSessionName' => "DemoAssumeRoleSession_$uuid",
]);
$assumedCredentials = [
    'key' => $assumedRole['Credentials']['AccessKeyId'],
    'secret' => $assumedRole['Credentials']['SecretAccessKey'],
    'token' => $assumedRole['Credentials']['SessionToken'],
];
$s3Client = new S3Client(['region' => 'us-west-2', 'version' => 'latest', 'credentials' => $assumedCredentials]);
try {
    $s3Client->listBuckets([]);
    echo "this should now run!\n";
} catch (S3Exception $exception) {
    echo "this should now not fail\n";
}

$service->detachRolePolicy($assumeRoleRole['RoleName'], $listAllBucketsPolicy['Arn']);
$deletePolicy = $service->deletePolicy($listAllBucketsPolicy['Arn']);
echo "Delete policy: {$listAllBucketsPolicy['PolicyName']}\n";
$deletedRole = $service->deleteRole($assumeRoleRole['Arn']);
echo "Deleted role: {$assumeRoleRole['RoleName']}\n";
$deletedKey = $service->deleteAccessKey($key['AccessKeyId'], $user['UserName']);
$deletedUser = $service->deleteUser($user['UserName']);
echo "Delete user: {$user['UserName']}\n";

如需 API 詳細資訊，請參閱 AWS SDK for PHP API 參考中的下列主題。

動作

下列程式碼範例示範如何使用 AttachRolePolicy。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

$assumeRolePolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Principal\": {\"AWS\": \"{$user['Arn']}\"},
                    \"Action\": \"sts:AssumeRole\"
                }]
            }";
$assumeRoleRole = $service->createRole("iam_demo_role_$uuid", $assumeRolePolicyDocument);
echo "Created role: {$assumeRoleRole['RoleName']}\n";

$listAllBucketsPolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Action\": \"s3:ListAllMyBuckets\",
                    \"Resource\": \"arn:aws:s3:::*\"}]
}";
$listAllBucketsPolicy = $service->createPolicy("iam_demo_policy_$uuid", $listAllBucketsPolicyDocument);
echo "Created policy: {$listAllBucketsPolicy['PolicyName']}\n";

$service->attachRolePolicy($assumeRoleRole['RoleName'], $listAllBucketsPolicy['Arn']);

    public function attachRolePolicy($roleName, $policyArn)
    {
        return $this->customWaiter(function () use ($roleName, $policyArn) {
            $this->iamClient->attachRolePolicy([
                'PolicyArn' => $policyArn,
                'RoleName' => $roleName,
            ]);
        });
    }

如需 API 詳細資訊，請參閱 AttachRolePolicy AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 CreatePolicy。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

$listAllBucketsPolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Action\": \"s3:ListAllMyBuckets\",
                    \"Resource\": \"arn:aws:s3:::*\"}]
}";
$listAllBucketsPolicy = $service->createPolicy("iam_demo_policy_$uuid", $listAllBucketsPolicyDocument);
echo "Created policy: {$listAllBucketsPolicy['PolicyName']}\n";

    /**
     * @param string $policyName
     * @param string $policyDocument
     * @return array
     */
    public function createPolicy(string $policyName, string $policyDocument)
    {
        $result = $this->customWaiter(function () use ($policyName, $policyDocument) {
            return $this->iamClient->createPolicy([
                'PolicyName' => $policyName,
                'PolicyDocument' => $policyDocument,
            ]);
        });
        return $result['Policy'];
    }

如需 API 詳細資訊，請參閱 CreatePolicy AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 CreateRole。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

$assumeRolePolicyDocument = "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [{
                    \"Effect\": \"Allow\",
                    \"Principal\": {\"AWS\": \"{$user['Arn']}\"},
                    \"Action\": \"sts:AssumeRole\"
                }]
            }";
$assumeRoleRole = $service->createRole("iam_demo_role_$uuid", $assumeRolePolicyDocument);
echo "Created role: {$assumeRoleRole['RoleName']}\n";

    /**
     * @param string $roleName
     * @param string $rolePolicyDocument
     * @return array
     * @throws AwsException
     */
    public function createRole(string $roleName, string $rolePolicyDocument)
    {
        $result = $this->customWaiter(function () use ($roleName, $rolePolicyDocument) {
            return $this->iamClient->createRole([
                'AssumeRolePolicyDocument' => $rolePolicyDocument,
                'RoleName' => $roleName,
            ]);
        });
        return $result['Role'];
    }

如需 API 詳細資訊，請參閱 CreateRole AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 CreateServiceLinkedRole。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function createServiceLinkedRole($awsServiceName, $customSuffix = "", $description = "")
    {
        $createServiceLinkedRoleArguments = ['AWSServiceName' => $awsServiceName];
        if ($customSuffix) {
            $createServiceLinkedRoleArguments['CustomSuffix'] = $customSuffix;
        }
        if ($description) {
            $createServiceLinkedRoleArguments['Description'] = $description;
        }
        return $this->iamClient->createServiceLinkedRole($createServiceLinkedRoleArguments);
    }

如需 API 詳細資訊，請參閱 CreateServiceLinkedRole AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 CreateUser。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

$user = $service->createUser("iam_demo_user_$uuid");
echo "Created user with the arn: {$user['Arn']}\n";


    /**
     * @param string $name
     * @return array
     * @throws AwsException
     */
    public function createUser(string $name): array
    {
        $result = $this->iamClient->createUser([
            'UserName' => $name,
        ]);

        return $result['User'];
    }

如需 API 詳細資訊，請參閱 CreateUser AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 GetAccountPasswordPolicy。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function getAccountPasswordPolicy()
    {
        return $this->iamClient->getAccountPasswordPolicy();
    }

如需 API 詳細資訊，請參閱 GetAccountPasswordPolicy AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 GetPolicy。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function getPolicy($policyArn)
    {
        return $this->customWaiter(function () use ($policyArn) {
            return $this->iamClient->getPolicy(['PolicyArn' => $policyArn]);
        });
    }

如需 API 詳細資訊，請參閱 GetPolicy AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 GetRole。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function getRole($roleName)
    {
        return $this->customWaiter(function () use ($roleName) {
            return $this->iamClient->getRole(['RoleName' => $roleName]);
        });
    }

如需 API 詳細資訊，請參閱 GetRole AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 ListAttachedRolePolicies。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function listAttachedRolePolicies($roleName, $pathPrefix = "", $marker = "", $maxItems = 0)
    {
        $listAttachRolePoliciesArguments = ['RoleName' => $roleName];
        if ($pathPrefix) {
            $listAttachRolePoliciesArguments['PathPrefix'] = $pathPrefix;
        }
        if ($marker) {
            $listAttachRolePoliciesArguments['Marker'] = $marker;
        }
        if ($maxItems) {
            $listAttachRolePoliciesArguments['MaxItems'] = $maxItems;
        }
        return $this->iamClient->listAttachedRolePolicies($listAttachRolePoliciesArguments);
    }

如需 API 詳細資訊，請參閱 ListAttachedRolePolicies AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 ListGroups。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function listGroups($pathPrefix = "", $marker = "", $maxItems = 0)
    {
        $listGroupsArguments = [];
        if ($pathPrefix) {
            $listGroupsArguments["PathPrefix"] = $pathPrefix;
        }
        if ($marker) {
            $listGroupsArguments["Marker"] = $marker;
        }
        if ($maxItems) {
            $listGroupsArguments["MaxItems"] = $maxItems;
        }

        return $this->iamClient->listGroups($listGroupsArguments);
    }

如需 API 詳細資訊，請參閱 ListGroups AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 ListPolicies。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function listPolicies($pathPrefix = "", $marker = "", $maxItems = 0)
    {
        $listPoliciesArguments = [];
        if ($pathPrefix) {
            $listPoliciesArguments["PathPrefix"] = $pathPrefix;
        }
        if ($marker) {
            $listPoliciesArguments["Marker"] = $marker;
        }
        if ($maxItems) {
            $listPoliciesArguments["MaxItems"] = $maxItems;
        }

        return $this->iamClient->listPolicies($listPoliciesArguments);
    }

如需 API 詳細資訊，請參閱 ListPolicies AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 ListRolePolicies。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function listRolePolicies($roleName, $marker = "", $maxItems = 0)
    {
        $listRolePoliciesArguments = ['RoleName' => $roleName];
        if ($marker) {
            $listRolePoliciesArguments['Marker'] = $marker;
        }
        if ($maxItems) {
            $listRolePoliciesArguments['MaxItems'] = $maxItems;
        }
        return $this->customWaiter(function () use ($listRolePoliciesArguments) {
            return $this->iamClient->listRolePolicies($listRolePoliciesArguments);
        });
    }

如需 API 詳細資訊，請參閱 ListRolePolicies AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 ListRoles。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    /**
     * @param string $pathPrefix
     * @param string $marker
     * @param int $maxItems
     * @return Result
     * $roles = $service->listRoles();
     */
    public function listRoles($pathPrefix = "", $marker = "", $maxItems = 0)
    {
        $listRolesArguments = [];
        if ($pathPrefix) {
            $listRolesArguments["PathPrefix"] = $pathPrefix;
        }
        if ($marker) {
            $listRolesArguments["Marker"] = $marker;
        }
        if ($maxItems) {
            $listRolesArguments["MaxItems"] = $maxItems;
        }
        return $this->iamClient->listRoles($listRolesArguments);
    }

如需 API 詳細資訊，請參閱 ListRoles AWS SDK for PHP 參考中的 API。

下列程式碼範例示範如何使用 ListSAMLProviders。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function listSAMLProviders()
    {
        return $this->iamClient->listSAMLProviders();
    }

如需 API 詳細資訊，請參閱 istSAMLProviders 參考中的 LWordAWS SDK for PHP API。

下列程式碼範例示範如何使用 ListUsers。

適用於 PHP 的 SDK

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


$uuid = uniqid();
$service = new IAMService();

    public function listUsers($pathPrefix = "", $marker = "", $maxItems = 0)
    {
        $listUsersArguments = [];
        if ($pathPrefix) {
            $listUsersArguments["PathPrefix"] = $pathPrefix;
        }
        if ($marker) {
            $listUsersArguments["Marker"] = $marker;
        }
        if ($maxItems) {
            $listUsersArguments["MaxItems"] = $maxItems;
        }

        return $this->iamClient->listUsers($listUsersArguments);
    }

如需 API 詳細資訊，請參閱 ListUsers AWS SDK for PHP 參考中的 API。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

AWS Glue

Kinesis