KmsClient
extends AwsClient
This client is used to interact with the AWS Key Management Service.
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version option given when constructing the
client. The version option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */), or using the
$client->getCommand method of the client.
Examples
Basics, Actions and Scenarios
The following code examples show you how to perform actions and implement common scenarios by using the AWS SDK for PHP with AWS Key Management Service.
Legacy Code Examples With Guidance
The following examples demonstrate how to use this service with the AWS SDK for PHP. These code examples are available in the AWS SDK for PHP Developer Guide.
-
phpstan-method
-
\Aws\Result cancelKeyDeletion(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise cancelKeyDeletionAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result connectCustomKeyStore(array{CustomKeyStoreId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise connectCustomKeyStoreAsync(array{CustomKeyStoreId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result createAlias(array{AliasName?: string, TargetKeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise createAliasAsync(array{AliasName?: string, TargetKeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result createCustomKeyStore(array{
CustomKeyStoreName?: string,
CloudHsmClusterId?: string,
TrustAnchorCertificate?: string,
KeyStorePassword?: string,
CustomKeyStoreType?: 'AWS_CLOUDHSM'|'EXTERNAL_KEY_STORE',
XksProxyUriEndpoint?: string,
XksProxyUriPath?: string,
XksProxyVpcEndpointServiceName?: string,
XksProxyVpcEndpointServiceOwner?: string,
XksProxyAuthenticationCredential?: array{AccessKeyId?: string, RawSecretAccessKey?: string, ...},
XksProxyConnectivity?: 'PUBLIC_ENDPOINT'|'VPC_ENDPOINT_SERVICE',
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise createCustomKeyStoreAsync(array{
CustomKeyStoreName?: string,
CloudHsmClusterId?: string,
TrustAnchorCertificate?: string,
KeyStorePassword?: string,
CustomKeyStoreType?: 'AWS_CLOUDHSM'|'EXTERNAL_KEY_STORE',
XksProxyUriEndpoint?: string,
XksProxyUriPath?: string,
XksProxyVpcEndpointServiceName?: string,
XksProxyVpcEndpointServiceOwner?: string,
XksProxyAuthenticationCredential?: array{AccessKeyId?: string, RawSecretAccessKey?: string, ...},
XksProxyConnectivity?: 'PUBLIC_ENDPOINT'|'VPC_ENDPOINT_SERVICE',
...,
} $args = [])
-
phpstan-method
-
\Aws\Result createGrant(array{
KeyId?: string,
GranteePrincipal?: string,
RetiringPrincipal?: string,
Operations?: list<'CreateGrant'|'Decrypt'|'DeriveSharedSecret'|'DescribeKey'|'Encrypt'|'GenerateDataKey'|'GenerateDataKeyPair'|'GenerateDataKeyPairWithoutPlaintext'|'GenerateDataKeyWithoutPlaintext'|'GenerateMac'|'GetPublicKey'|'ReEncryptFrom'|'ReEncryptTo'|'RetireGrant'|'Sign'|'Verify'|'VerifyMac'>,
Constraints?: array{
EncryptionContextSubset?: array<string, string>,
EncryptionContextEquals?: array<string, string>,
SourceArn?: string,
...,
},
GrantTokens?: list,
Name?: string,
DryRun?: bool,
GranteeServicePrincipal?: string,
RetiringServicePrincipal?: string,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise createGrantAsync(array{
KeyId?: string,
GranteePrincipal?: string,
RetiringPrincipal?: string,
Operations?: list<'CreateGrant'|'Decrypt'|'DeriveSharedSecret'|'DescribeKey'|'Encrypt'|'GenerateDataKey'|'GenerateDataKeyPair'|'GenerateDataKeyPairWithoutPlaintext'|'GenerateDataKeyWithoutPlaintext'|'GenerateMac'|'GetPublicKey'|'ReEncryptFrom'|'ReEncryptTo'|'RetireGrant'|'Sign'|'Verify'|'VerifyMac'>,
Constraints?: array{
EncryptionContextSubset?: array<string, string>,
EncryptionContextEquals?: array<string, string>,
SourceArn?: string,
...,
},
GrantTokens?: list,
Name?: string,
DryRun?: bool,
GranteeServicePrincipal?: string,
RetiringServicePrincipal?: string,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result createKey(array{
Policy?: string,
Description?: string,
KeyUsage?: 'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC'|'KEY_AGREEMENT'|'SIGN_VERIFY',
CustomerMasterKeySpec?: 'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2'|'SYMMETRIC_DEFAULT',
KeySpec?: 'ECC_NIST_EDWARDS25519'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512'|'ML_DSA_44'|'ML_DSA_65'|'ML_DSA_87'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2'|'SYMMETRIC_DEFAULT',
Origin?: 'AWS_CLOUDHSM'|'AWS_KMS'|'EXTERNAL'|'EXTERNAL_KEY_STORE',
CustomKeyStoreId?: string,
BypassPolicyLockoutSafetyCheck?: bool,
Tags?: list<array{TagKey?: string, TagValue?: string, ...}>,
MultiRegion?: bool,
XksKeyId?: string,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise createKeyAsync(array{
Policy?: string,
Description?: string,
KeyUsage?: 'ENCRYPT_DECRYPT'|'GENERATE_VERIFY_MAC'|'KEY_AGREEMENT'|'SIGN_VERIFY',
CustomerMasterKeySpec?: 'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2'|'SYMMETRIC_DEFAULT',
KeySpec?: 'ECC_NIST_EDWARDS25519'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'HMAC_224'|'HMAC_256'|'HMAC_384'|'HMAC_512'|'ML_DSA_44'|'ML_DSA_65'|'ML_DSA_87'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2'|'SYMMETRIC_DEFAULT',
Origin?: 'AWS_CLOUDHSM'|'AWS_KMS'|'EXTERNAL'|'EXTERNAL_KEY_STORE',
CustomKeyStoreId?: string,
BypassPolicyLockoutSafetyCheck?: bool,
Tags?: list<array{TagKey?: string, TagValue?: string, ...}>,
MultiRegion?: bool,
XksKeyId?: string,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result decrypt(array{
CiphertextBlob?: string|resource|\Psr\Http\Message\StreamInterface,
EncryptionContext?: array<string, string>,
GrantTokens?: list,
KeyId?: string,
EncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
DryRun?: bool,
DryRunModifiers?: list<'IGNORE_CIPHERTEXT'>,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise decryptAsync(array{
CiphertextBlob?: string|resource|\Psr\Http\Message\StreamInterface,
EncryptionContext?: array<string, string>,
GrantTokens?: list,
KeyId?: string,
EncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
DryRun?: bool,
DryRunModifiers?: list<'IGNORE_CIPHERTEXT'>,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result deleteAlias(array{AliasName?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise deleteAliasAsync(array{AliasName?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result deleteCustomKeyStore(array{CustomKeyStoreId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise deleteCustomKeyStoreAsync(array{CustomKeyStoreId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result deleteImportedKeyMaterial(array{KeyId?: string, KeyMaterialId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise deleteImportedKeyMaterialAsync(array{KeyId?: string, KeyMaterialId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result deriveSharedSecret(array{
KeyId?: string,
KeyAgreementAlgorithm?: 'ECDH',
PublicKey?: string|resource|\Psr\Http\Message\StreamInterface,
GrantTokens?: list,
DryRun?: bool,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise deriveSharedSecretAsync(array{
KeyId?: string,
KeyAgreementAlgorithm?: 'ECDH',
PublicKey?: string|resource|\Psr\Http\Message\StreamInterface,
GrantTokens?: list,
DryRun?: bool,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
...,
} $args = [])
-
phpstan-method
-
\Aws\Result describeCustomKeyStores(array{CustomKeyStoreId?: string, CustomKeyStoreName?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise describeCustomKeyStoresAsync(array{CustomKeyStoreId?: string, CustomKeyStoreName?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result describeKey(array{KeyId?: string, GrantTokens?: list, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise describeKeyAsync(array{KeyId?: string, GrantTokens?: list, ...} $args = [])
-
phpstan-method
-
\Aws\Result disableKey(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise disableKeyAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result disableKeyRotation(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise disableKeyRotationAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result disconnectCustomKeyStore(array{CustomKeyStoreId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise disconnectCustomKeyStoreAsync(array{CustomKeyStoreId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result enableKey(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise enableKeyAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result enableKeyRotation(array{KeyId?: string, RotationPeriodInDays?: int, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise enableKeyRotationAsync(array{KeyId?: string, RotationPeriodInDays?: int, ...} $args = [])
-
phpstan-method
-
\Aws\Result encrypt(array{
KeyId?: string,
Plaintext?: string|resource|\Psr\Http\Message\StreamInterface,
EncryptionContext?: array<string, string>,
GrantTokens?: list,
EncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise encryptAsync(array{
KeyId?: string,
Plaintext?: string|resource|\Psr\Http\Message\StreamInterface,
EncryptionContext?: array<string, string>,
GrantTokens?: list,
EncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result generateDataKey(array{
KeyId?: string,
EncryptionContext?: array<string, string>,
NumberOfBytes?: int,
KeySpec?: 'AES_128'|'AES_256',
GrantTokens?: list,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise generateDataKeyAsync(array{
KeyId?: string,
EncryptionContext?: array<string, string>,
NumberOfBytes?: int,
KeySpec?: 'AES_128'|'AES_256',
GrantTokens?: list,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result generateDataKeyPair(array{
EncryptionContext?: array<string, string>,
KeyId?: string,
KeyPairSpec?: 'ECC_NIST_EDWARDS25519'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2',
GrantTokens?: list,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise generateDataKeyPairAsync(array{
EncryptionContext?: array<string, string>,
KeyId?: string,
KeyPairSpec?: 'ECC_NIST_EDWARDS25519'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2',
GrantTokens?: list,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result generateDataKeyPairWithoutPlaintext(array{
EncryptionContext?: array<string, string>,
KeyId?: string,
KeyPairSpec?: 'ECC_NIST_EDWARDS25519'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2',
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise generateDataKeyPairWithoutPlaintextAsync(array{
EncryptionContext?: array<string, string>,
KeyId?: string,
KeyPairSpec?: 'ECC_NIST_EDWARDS25519'|'ECC_NIST_P256'|'ECC_NIST_P384'|'ECC_NIST_P521'|'ECC_SECG_P256K1'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2',
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result generateDataKeyWithoutPlaintext(array{
KeyId?: string,
EncryptionContext?: array<string, string>,
KeySpec?: 'AES_128'|'AES_256',
NumberOfBytes?: int,
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise generateDataKeyWithoutPlaintextAsync(array{
KeyId?: string,
EncryptionContext?: array<string, string>,
KeySpec?: 'AES_128'|'AES_256',
NumberOfBytes?: int,
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result generateMac(array{
Message?: string|resource|\Psr\Http\Message\StreamInterface,
KeyId?: string,
MacAlgorithm?: 'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise generateMacAsync(array{
Message?: string|resource|\Psr\Http\Message\StreamInterface,
KeyId?: string,
MacAlgorithm?: 'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result generateRandom(array{
NumberOfBytes?: int,
CustomKeyStoreId?: string,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise generateRandomAsync(array{
NumberOfBytes?: int,
CustomKeyStoreId?: string,
Recipient?: array{
KeyEncryptionAlgorithm?: 'RSAES_OAEP_SHA_256',
AttestationDocument?: string|resource|\Psr\Http\Message\StreamInterface,
...,
},
...,
} $args = [])
-
phpstan-method
-
\Aws\Result getKeyLastUsage(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise getKeyLastUsageAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result getKeyPolicy(array{KeyId?: string, PolicyName?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise getKeyPolicyAsync(array{KeyId?: string, PolicyName?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result getKeyRotationStatus(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise getKeyRotationStatusAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result getParametersForImport(array{
KeyId?: string,
WrappingAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'RSAES_PKCS1_V1_5'|'RSA_AES_KEY_WRAP_SHA_1'|'RSA_AES_KEY_WRAP_SHA_256'|'SM2PKE',
WrappingKeySpec?: 'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2',
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise getParametersForImportAsync(array{
KeyId?: string,
WrappingAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'RSAES_PKCS1_V1_5'|'RSA_AES_KEY_WRAP_SHA_1'|'RSA_AES_KEY_WRAP_SHA_256'|'SM2PKE',
WrappingKeySpec?: 'RSA_2048'|'RSA_3072'|'RSA_4096'|'SM2',
...,
} $args = [])
-
phpstan-method
-
\Aws\Result getPublicKey(array{KeyId?: string, GrantTokens?: list, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise getPublicKeyAsync(array{KeyId?: string, GrantTokens?: list, ...} $args = [])
-
phpstan-method
-
\Aws\Result importKeyMaterial(array{
KeyId?: string,
ImportToken?: string|resource|\Psr\Http\Message\StreamInterface,
EncryptedKeyMaterial?: string|resource|\Psr\Http\Message\StreamInterface,
ValidTo?: int|string|\DateTimeInterface,
ExpirationModel?: 'KEY_MATERIAL_DOES_NOT_EXPIRE'|'KEY_MATERIAL_EXPIRES',
ImportType?: 'EXISTING_KEY_MATERIAL'|'NEW_KEY_MATERIAL',
KeyMaterialDescription?: string,
KeyMaterialId?: string,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise importKeyMaterialAsync(array{
KeyId?: string,
ImportToken?: string|resource|\Psr\Http\Message\StreamInterface,
EncryptedKeyMaterial?: string|resource|\Psr\Http\Message\StreamInterface,
ValidTo?: int|string|\DateTimeInterface,
ExpirationModel?: 'KEY_MATERIAL_DOES_NOT_EXPIRE'|'KEY_MATERIAL_EXPIRES',
ImportType?: 'EXISTING_KEY_MATERIAL'|'NEW_KEY_MATERIAL',
KeyMaterialDescription?: string,
KeyMaterialId?: string,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result listAliases(array{KeyId?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listAliasesAsync(array{KeyId?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result listGrants(array{
Limit?: int,
Marker?: string,
KeyId?: string,
GrantId?: string,
GranteePrincipal?: string,
GranteeServicePrincipal?: string,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listGrantsAsync(array{
Limit?: int,
Marker?: string,
KeyId?: string,
GrantId?: string,
GranteePrincipal?: string,
GranteeServicePrincipal?: string,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result listKeyPolicies(array{KeyId?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listKeyPoliciesAsync(array{KeyId?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result listKeyRotations(array{
KeyId?: string,
IncludeKeyMaterial?: 'ALL_KEY_MATERIAL'|'ROTATIONS_ONLY',
Limit?: int,
Marker?: string,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listKeyRotationsAsync(array{
KeyId?: string,
IncludeKeyMaterial?: 'ALL_KEY_MATERIAL'|'ROTATIONS_ONLY',
Limit?: int,
Marker?: string,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result listKeys(array{Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listKeysAsync(array{Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result listResourceTags(array{KeyId?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listResourceTagsAsync(array{KeyId?: string, Limit?: int, Marker?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result listRetirableGrants(array{Limit?: int, Marker?: string, RetiringPrincipal?: string, RetiringServicePrincipal?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise listRetirableGrantsAsync(array{Limit?: int, Marker?: string, RetiringPrincipal?: string, RetiringServicePrincipal?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result putKeyPolicy(array{KeyId?: string, PolicyName?: string, Policy?: string, BypassPolicyLockoutSafetyCheck?: bool, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise putKeyPolicyAsync(array{KeyId?: string, PolicyName?: string, Policy?: string, BypassPolicyLockoutSafetyCheck?: bool, ...} $args = [])
-
phpstan-method
-
\Aws\Result reEncrypt(array{
CiphertextBlob?: string|resource|\Psr\Http\Message\StreamInterface,
SourceEncryptionContext?: array<string, string>,
SourceKeyId?: string,
DestinationKeyId?: string,
DestinationEncryptionContext?: array<string, string>,
SourceEncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
DestinationEncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
GrantTokens?: list,
DryRun?: bool,
DryRunModifiers?: list<'IGNORE_CIPHERTEXT'>,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise reEncryptAsync(array{
CiphertextBlob?: string|resource|\Psr\Http\Message\StreamInterface,
SourceEncryptionContext?: array<string, string>,
SourceKeyId?: string,
DestinationKeyId?: string,
DestinationEncryptionContext?: array<string, string>,
SourceEncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
DestinationEncryptionAlgorithm?: 'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256'|'SM2PKE'|'SYMMETRIC_DEFAULT',
GrantTokens?: list,
DryRun?: bool,
DryRunModifiers?: list<'IGNORE_CIPHERTEXT'>,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result replicateKey(array{
KeyId?: string,
ReplicaRegion?: string,
Policy?: string,
BypassPolicyLockoutSafetyCheck?: bool,
Description?: string,
Tags?: list<array{TagKey?: string, TagValue?: string, ...}>,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise replicateKeyAsync(array{
KeyId?: string,
ReplicaRegion?: string,
Policy?: string,
BypassPolicyLockoutSafetyCheck?: bool,
Description?: string,
Tags?: list<array{TagKey?: string, TagValue?: string, ...}>,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result retireGrant(array{GrantToken?: string, KeyId?: string, GrantId?: string, DryRun?: bool, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise retireGrantAsync(array{GrantToken?: string, KeyId?: string, GrantId?: string, DryRun?: bool, ...} $args = [])
-
phpstan-method
-
\Aws\Result revokeGrant(array{KeyId?: string, GrantId?: string, DryRun?: bool, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise revokeGrantAsync(array{KeyId?: string, GrantId?: string, DryRun?: bool, ...} $args = [])
-
phpstan-method
-
\Aws\Result rotateKeyOnDemand(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise rotateKeyOnDemandAsync(array{KeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result scheduleKeyDeletion(array{KeyId?: string, PendingWindowInDays?: int, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise scheduleKeyDeletionAsync(array{KeyId?: string, PendingWindowInDays?: int, ...} $args = [])
-
phpstan-method
-
\Aws\Result sign(array{
KeyId?: string,
Message?: string|resource|\Psr\Http\Message\StreamInterface,
MessageType?: 'DIGEST'|'EXTERNAL_MU'|'RAW',
GrantTokens?: list,
SigningAlgorithm?: 'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512'|'ED25519_PH_SHA_512'|'ED25519_SHA_512'|'ML_DSA_SHAKE_256'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'SM2DSA',
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise signAsync(array{
KeyId?: string,
Message?: string|resource|\Psr\Http\Message\StreamInterface,
MessageType?: 'DIGEST'|'EXTERNAL_MU'|'RAW',
GrantTokens?: list,
SigningAlgorithm?: 'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512'|'ED25519_PH_SHA_512'|'ED25519_SHA_512'|'ML_DSA_SHAKE_256'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'SM2DSA',
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result tagResource(array{KeyId?: string, Tags?: list<array{TagKey?: string, TagValue?: string, ...}>, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise tagResourceAsync(array{KeyId?: string, Tags?: list<array{TagKey?: string, TagValue?: string, ...}>, ...} $args = [])
-
phpstan-method
-
\Aws\Result untagResource(array{KeyId?: string, TagKeys?: list, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise untagResourceAsync(array{KeyId?: string, TagKeys?: list, ...} $args = [])
-
phpstan-method
-
\Aws\Result updateAlias(array{AliasName?: string, TargetKeyId?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise updateAliasAsync(array{AliasName?: string, TargetKeyId?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result updateCustomKeyStore(array{
CustomKeyStoreId?: string,
NewCustomKeyStoreName?: string,
KeyStorePassword?: string,
CloudHsmClusterId?: string,
XksProxyUriEndpoint?: string,
XksProxyUriPath?: string,
XksProxyVpcEndpointServiceName?: string,
XksProxyVpcEndpointServiceOwner?: string,
XksProxyAuthenticationCredential?: array{AccessKeyId?: string, RawSecretAccessKey?: string, ...},
XksProxyConnectivity?: 'PUBLIC_ENDPOINT'|'VPC_ENDPOINT_SERVICE',
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise updateCustomKeyStoreAsync(array{
CustomKeyStoreId?: string,
NewCustomKeyStoreName?: string,
KeyStorePassword?: string,
CloudHsmClusterId?: string,
XksProxyUriEndpoint?: string,
XksProxyUriPath?: string,
XksProxyVpcEndpointServiceName?: string,
XksProxyVpcEndpointServiceOwner?: string,
XksProxyAuthenticationCredential?: array{AccessKeyId?: string, RawSecretAccessKey?: string, ...},
XksProxyConnectivity?: 'PUBLIC_ENDPOINT'|'VPC_ENDPOINT_SERVICE',
...,
} $args = [])
-
phpstan-method
-
\Aws\Result updateKeyDescription(array{KeyId?: string, Description?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise updateKeyDescriptionAsync(array{KeyId?: string, Description?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result updatePrimaryRegion(array{KeyId?: string, PrimaryRegion?: string, ...} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise updatePrimaryRegionAsync(array{KeyId?: string, PrimaryRegion?: string, ...} $args = [])
-
phpstan-method
-
\Aws\Result verify(array{
KeyId?: string,
Message?: string|resource|\Psr\Http\Message\StreamInterface,
MessageType?: 'DIGEST'|'EXTERNAL_MU'|'RAW',
Signature?: string|resource|\Psr\Http\Message\StreamInterface,
SigningAlgorithm?: 'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512'|'ED25519_PH_SHA_512'|'ED25519_SHA_512'|'ML_DSA_SHAKE_256'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'SM2DSA',
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise verifyAsync(array{
KeyId?: string,
Message?: string|resource|\Psr\Http\Message\StreamInterface,
MessageType?: 'DIGEST'|'EXTERNAL_MU'|'RAW',
Signature?: string|resource|\Psr\Http\Message\StreamInterface,
SigningAlgorithm?: 'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512'|'ED25519_PH_SHA_512'|'ED25519_SHA_512'|'ML_DSA_SHAKE_256'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'SM2DSA',
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\Aws\Result verifyMac(array{
Message?: string|resource|\Psr\Http\Message\StreamInterface,
KeyId?: string,
MacAlgorithm?: 'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
Mac?: string|resource|\Psr\Http\Message\StreamInterface,
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
-
phpstan-method
-
\GuzzleHttp\Promise\Promise verifyMacAsync(array{
Message?: string|resource|\Psr\Http\Message\StreamInterface,
KeyId?: string,
MacAlgorithm?: 'HMAC_SHA_224'|'HMAC_SHA_256'|'HMAC_SHA_384'|'HMAC_SHA_512',
Mac?: string|resource|\Psr\Http\Message\StreamInterface,
GrantTokens?: list,
DryRun?: bool,
...,
} $args = [])
Table of Contents
Methods
-
__call()
: mixed
-
__construct()
: mixed
- The client constructor accepts the following options:
-
__sleep()
: mixed
-
execute()
: mixed
-
executeAsync()
: mixed
-
factory()
: static
-
getApi()
: Service
-
getArguments()
: array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
-
getClientBuiltIns()
: array<string|int, mixed>
- Provides the set of built-in keys and values
used for endpoint resolution
-
getClientContextParams()
: array<string|int, mixed>
- Provides the set of service context parameter
key-value pairs used for endpoint resolution.
-
getCommand()
: CommandInterface
-
getConfig()
: mixed|null
- Get a client configuration value.
-
getCredentials()
: PromiseInterface
- Returns a promise that is fulfilled with an
{@see \Aws\Credentials\CredentialsInterface} object.
-
getEndpoint()
: UriInterface
- Gets the default endpoint, or base URL, used by the client.
-
getEndpointProvider()
: mixed
-
getEndpointProviderArgs()
: array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
-
getHandlerList()
: HandlerList
- Get the handler list used to transfer commands.
-
getIterator()
: mixed
-
getPaginator()
: mixed
-
getRegion()
: string
- Get the region to which the client is configured to send requests.
-
getSignatureProvider()
: callable
- Get the signature_provider function of the client.
-
getToken()
: mixed
-
getWaiter()
: mixed
-
waitUntil()
: mixed
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
-
$name
: mixed
-
-
$args
: array<string|int, mixed>
-
__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a
type, service, and version argument, and returns an array of
corresponding configuration data. The type value can be one of api,
waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
false to use null
credentials, or a callable credentials provider used to create
credentials or return null. See Aws\Credentials\CredentialProvider for
a list of built-in credentials providers. If no credentials are
provided, the SDK will attempt to load them from the environment.
- token:
(Aws\Token\TokenInterface|array|bool|callable) Specifies
the token used to authorize requests. Provide an
Aws\Token\TokenInterface object, an associative array of
"token" and an optional "expires" key,
false to use no
token, or a callable token provider used to create a
token or return null. See Aws\Token\TokenProvider for
a list of built-in token providers. If no token is
provided, the SDK will attempt to load one from the environment.
- csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
false to disable csm, or an associative array with the following keys:
enabled: (bool) Set to true to enable client-side monitoring, defaults
to false; host: (string) the host location to send monitoring events to,
defaults to 127.0.0.1; port: (int) The port used for the host connection,
defaults to 31000; client_id: (string) An identifier for this project
- debug: (bool|array) Set to true to display debug information when
sending requests. Alternatively, you can provide an associative array
with the following keys: logfn: (callable) Function that is invoked
with log messages; stream_size: (int) When the size of a stream is
greater than this number, the stream data will not be logged (set to
"0" to not log any stream data); scrub_auth: (bool) Set to false to
disable the scrubbing of auth data from the logged messages; http:
(bool) Set to false to disable the "debug" feature of lower level HTTP
adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiver option for this to have an effect; timer: (bool)
Set to true to enable a command timer that reports the total wall clock
time spent on an operation in seconds.
- disable_host_prefix_injection: (bool) Set to true to disable host prefix
injection logic for services that use it. This disables the entire
prefix injection, including the portions supplied by user-defined
parameters. Setting this flag will have no effect on services that do
not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only
required when connecting to a custom endpoint (e.g., a local version
of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface,
Aws\CacheInterface, array, callable) Settings for endpoint discovery.
Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface,
an instance Aws\CacheInterface, a callable that provides a promise for
a Configuration object, or an associative array with the following
keys: enabled: (bool) Set to true to enable endpoint discovery, false
to explicitly disable it, defaults to false; cache_limit: (int) The
maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that
accepts a hash of options including a "service" and "region" key and
returns NULL or a hash of endpoint data, of which the "endpoint" key
is required. See Aws\Endpoint\EndpointProvider for a list of built-in
providers.
- handler: (callable) A handler that accepts a command object,
request object and returns a promise that is fulfilled with an
Aws\ResultInterface object or rejected with an
Aws\Exception\AwsException. A handler does not accept a next handler
as it is terminal and expected to fulfill a command. If no handler is
provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request
options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that
accepts a PSR-7 request object and returns a promise that is fulfilled
with a PSR-7 response object or rejected with an array of exception
data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to
populate parameters that enabled 'idempotencyToken' trait with a random
UUID v4 value on your behalf. Using default value 'true' still allows
parameter value to be overwritten when provided. Note: auto-fill only
works when cryptographically secure random bytes generator functions
(random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be
found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when
credentials are created from the AWS credentials file in your HOME
directory. This setting overrides the AWS_PROFILE environment
variable. Note: Specifying "profile" will cause the "credentials" key
to be ignored.
- region: (string, required) Region to connect to. See
http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of
available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface,
array, callable) Configures the retry mode and maximum number of
allowed retries for a client (pass 0 to disable retries). Provide an
integer for 'legacy' mode with the specified number of retries.
Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an
instance of Aws\CacheInterface, a callable function, or an array with
the following keys: mode: (string) Set to 'legacy', 'standard' (uses
retry quota management), or 'adapative' (an experimental mode that adds
client-side rate limiting to standard mode); max_attempts (int) The
maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
scheme to
"http".
- signature_provider: (callable) A callable that accepts a signature
version name (e.g., "v4"), a service name, and region, and
returns a SignatureInterface object or null. This provider is used to
create signers utilized by the client. See
Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom
signature version to use with a service (e.g., v4). Note that
per/operation signature version MAY override this requested signature
version.
- transport_sharing: (string) Set to a transport sharing mode ("none",
"handler_prefer", "handler_require", "persistent_prefer", or
"persistent_require") to enable connection sharing on the default
HTTP handler. The "_prefer" modes degrade gracefully when the
installed version of Guzzle or the runtime cannot honor them, and
the "_require" modes throw. This option only applies when the SDK
creates the default HTTP handler.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to
disable checking for shared config file in '~/.aws/config' and
'~/.aws/credentials'. This will override the AWS_CONFIG_FILE
environment variable.
- validate: (bool, default=bool(true)) Set to false to disable
client-side parameter validation.
- version: (string, required) The version of the webservice to
utilize (e.g., 2006-03-01).
- account_id_endpoint_mode: (string, default(preferred)) this option
decides whether credentials should resolve an accountId value,
which is going to be used as part of the endpoint resolution.
The valid values for this option are:
- preferred: when this value is set then, a warning is logged when
accountId is empty in the resolved identity.
- required: when this value is set then, an exception is thrown when
accountId is empty in the resolved identity.
- disabled: when this value is set then, the validation for if accountId
was resolved or not, is ignored.
- ua_append: (string, array) To pass custom user agent parameters.
- app_id: (string) an optional application specific identifier that can be set.
When set it will be appended to the User-Agent header of every request
in the form of App/{AppId}. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for
more information on environment variables and shared config settings.
Parameters
-
$args
: array<string|int, mixed>
-
Client configuration arguments.
-
throws
-
InvalidArgumentException
if any required options are missing or
the service is not supported.
__sleep()
public
__sleep() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
-
$command
: CommandInterface
-
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
-
$command
: CommandInterface
-
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
-
$config
: array<string|int, mixed>
= []
-
-
deprecated
-
getApi()
public
abstract getApi() : Service
getArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>
getClientBuiltIns()
Provides the set of built-in keys and values
used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>
getClientContextParams()
Provides the set of service context parameter
key-value pairs used for endpoint resolution.
public
getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>
getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
-
$name
: string
-
-
$args
: array<string|int, mixed>
= []
-
getConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
-
$option
: mixed
= null
-
The option to retrieve. Pass null to retrieve
all options.
getCredentials()
Returns a promise that is fulfilled with an
{@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method
on the returned promise.
getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
getEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>
getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying
handler used to send HTTP requests.
getIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
-
$name
: mixed
-
-
$args
: array<string|int, mixed>
= []
-
getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
-
$name
: mixed
-
-
$args
: array<string|int, mixed>
= []
-
getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
getToken()
public
getToken() : mixed
getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
-
$name
: mixed
-
-
$args
: array<string|int, mixed>
= []
-
waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
-
$name
: mixed
-
-
$args
: array<string|int, mixed>
= []
-
<-- modeled_exceptions -->
SDK for PHP V3