SDK for PHP V3

ApiGatewayClient extends AwsClient
in package

This client is used to interact with the AWS API Gateway 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 Amazon API Gateway.

Tags
phpstan-method

\Aws\Result createApiKey(array{ name?: string, description?: string, enabled?: bool, generateDistinctId?: bool, value?: string, stageKeys?: list<array{restApiId?: string, stageName?: string, ...}>, customerId?: string, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createApiKeyAsync(array{ name?: string, description?: string, enabled?: bool, generateDistinctId?: bool, value?: string, stageKeys?: list<array{restApiId?: string, stageName?: string, ...}>, customerId?: string, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result createAuthorizer(array{ restApiId?: string, name?: string, type?: 'COGNITO_USER_POOLS'|'REQUEST'|'TOKEN', providerARNs?: list, authType?: string, authorizerUri?: string, authorizerCredentials?: string, identitySource?: string, identityValidationExpression?: string, authorizerResultTtlInSeconds?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createAuthorizerAsync(array{ restApiId?: string, name?: string, type?: 'COGNITO_USER_POOLS'|'REQUEST'|'TOKEN', providerARNs?: list, authType?: string, authorizerUri?: string, authorizerCredentials?: string, identitySource?: string, identityValidationExpression?: string, authorizerResultTtlInSeconds?: int, ..., } $args = [])

phpstan-method

\Aws\Result createBasePathMapping(array{domainName?: string, domainNameId?: string, basePath?: string, restApiId?: string, stage?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createBasePathMappingAsync(array{domainName?: string, domainNameId?: string, basePath?: string, restApiId?: string, stage?: string, ...} $args = [])

phpstan-method

\Aws\Result createDeployment(array{ restApiId?: string, stageName?: string, stageDescription?: string, description?: string, cacheClusterEnabled?: bool, cacheClusterSize?: '0.5'|'1.6'|'118'|'13.5'|'237'|'28.4'|'58.2'|'6.1', variables?: array<string, string>, canarySettings?: array{percentTraffic?: float, stageVariableOverrides?: array<string, string>, useStageCache?: bool, ...}, tracingEnabled?: bool, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createDeploymentAsync(array{ restApiId?: string, stageName?: string, stageDescription?: string, description?: string, cacheClusterEnabled?: bool, cacheClusterSize?: '0.5'|'1.6'|'118'|'13.5'|'237'|'28.4'|'58.2'|'6.1', variables?: array<string, string>, canarySettings?: array{percentTraffic?: float, stageVariableOverrides?: array<string, string>, useStageCache?: bool, ...}, tracingEnabled?: bool, ..., } $args = [])

phpstan-method

\Aws\Result createDocumentationPart(array{ restApiId?: string, location?: array{ type?: 'API'|'AUTHORIZER'|'METHOD'|'MODEL'|'PATH_PARAMETER'|'QUERY_PARAMETER'|'REQUEST_BODY'|'REQUEST_HEADER'|'RESOURCE'|'RESPONSE'|'RESPONSE_BODY'|'RESPONSE_HEADER', path?: string, method?: string, statusCode?: string, name?: string, ..., }, properties?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createDocumentationPartAsync(array{ restApiId?: string, location?: array{ type?: 'API'|'AUTHORIZER'|'METHOD'|'MODEL'|'PATH_PARAMETER'|'QUERY_PARAMETER'|'REQUEST_BODY'|'REQUEST_HEADER'|'RESOURCE'|'RESPONSE'|'RESPONSE_BODY'|'RESPONSE_HEADER', path?: string, method?: string, statusCode?: string, name?: string, ..., }, properties?: string, ..., } $args = [])

phpstan-method

\Aws\Result createDocumentationVersion(array{restApiId?: string, documentationVersion?: string, stageName?: string, description?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createDocumentationVersionAsync(array{restApiId?: string, documentationVersion?: string, stageName?: string, description?: string, ...} $args = [])

phpstan-method

\Aws\Result createDomainName(array{ domainName?: string, certificateName?: string, certificateBody?: string, certificatePrivateKey?: string, certificateChain?: string, certificateArn?: string, regionalCertificateName?: string, regionalCertificateArn?: string, endpointConfiguration?: array{ types?: list<'EDGE'|'PRIVATE'|'REGIONAL'>, ipAddressType?: 'dualstack'|'ipv4', vpcEndpointIds?: list, ..., }, tags?: array<string, string>, securityPolicy?: 'SecurityPolicy_TLS12_2018_EDGE'|'SecurityPolicy_TLS12_PFS_2025_EDGE'|'SecurityPolicy_TLS13_1_2_2021_06'|'SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PQ_2025_09'|'SecurityPolicy_TLS13_1_3_2025_09'|'SecurityPolicy_TLS13_1_3_FIPS_2025_09'|'SecurityPolicy_TLS13_2025_EDGE'|'TLS_1_0'|'TLS_1_2', endpointAccessMode?: 'BASIC'|'STRICT', mutualTlsAuthentication?: array{truststoreUri?: string, truststoreVersion?: string, ...}, ownershipVerificationCertificateArn?: string, policy?: string, routingMode?: 'BASE_PATH_MAPPING_ONLY'|'ROUTING_RULE_ONLY'|'ROUTING_RULE_THEN_BASE_PATH_MAPPING', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createDomainNameAsync(array{ domainName?: string, certificateName?: string, certificateBody?: string, certificatePrivateKey?: string, certificateChain?: string, certificateArn?: string, regionalCertificateName?: string, regionalCertificateArn?: string, endpointConfiguration?: array{ types?: list<'EDGE'|'PRIVATE'|'REGIONAL'>, ipAddressType?: 'dualstack'|'ipv4', vpcEndpointIds?: list, ..., }, tags?: array<string, string>, securityPolicy?: 'SecurityPolicy_TLS12_2018_EDGE'|'SecurityPolicy_TLS12_PFS_2025_EDGE'|'SecurityPolicy_TLS13_1_2_2021_06'|'SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PQ_2025_09'|'SecurityPolicy_TLS13_1_3_2025_09'|'SecurityPolicy_TLS13_1_3_FIPS_2025_09'|'SecurityPolicy_TLS13_2025_EDGE'|'TLS_1_0'|'TLS_1_2', endpointAccessMode?: 'BASIC'|'STRICT', mutualTlsAuthentication?: array{truststoreUri?: string, truststoreVersion?: string, ...}, ownershipVerificationCertificateArn?: string, policy?: string, routingMode?: 'BASE_PATH_MAPPING_ONLY'|'ROUTING_RULE_ONLY'|'ROUTING_RULE_THEN_BASE_PATH_MAPPING', ..., } $args = [])

phpstan-method

\Aws\Result createDomainNameAccessAssociation(array{ domainNameArn?: string, accessAssociationSourceType?: 'VPCE', accessAssociationSource?: string, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createDomainNameAccessAssociationAsync(array{ domainNameArn?: string, accessAssociationSourceType?: 'VPCE', accessAssociationSource?: string, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result createModel(array{restApiId?: string, name?: string, description?: string, schema?: string, contentType?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createModelAsync(array{restApiId?: string, name?: string, description?: string, schema?: string, contentType?: string, ...} $args = [])

phpstan-method

\Aws\Result createRequestValidator(array{restApiId?: string, name?: string, validateRequestBody?: bool, validateRequestParameters?: bool, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createRequestValidatorAsync(array{restApiId?: string, name?: string, validateRequestBody?: bool, validateRequestParameters?: bool, ...} $args = [])

phpstan-method

\Aws\Result createResource(array{restApiId?: string, parentId?: string, pathPart?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createResourceAsync(array{restApiId?: string, parentId?: string, pathPart?: string, ...} $args = [])

phpstan-method

\Aws\Result createRestApi(array{ name?: string, description?: string, version?: string, cloneFrom?: string, binaryMediaTypes?: list, minimumCompressionSize?: int, apiKeySource?: 'AUTHORIZER'|'HEADER', endpointConfiguration?: array{ types?: list<'EDGE'|'PRIVATE'|'REGIONAL'>, ipAddressType?: 'dualstack'|'ipv4', vpcEndpointIds?: list, ..., }, policy?: string, tags?: array<string, string>, disableExecuteApiEndpoint?: bool, securityPolicy?: 'SecurityPolicy_TLS12_2018_EDGE'|'SecurityPolicy_TLS12_PFS_2025_EDGE'|'SecurityPolicy_TLS13_1_2_2021_06'|'SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PQ_2025_09'|'SecurityPolicy_TLS13_1_3_2025_09'|'SecurityPolicy_TLS13_1_3_FIPS_2025_09'|'SecurityPolicy_TLS13_2025_EDGE'|'TLS_1_0'|'TLS_1_2', endpointAccessMode?: 'BASIC'|'STRICT', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createRestApiAsync(array{ name?: string, description?: string, version?: string, cloneFrom?: string, binaryMediaTypes?: list, minimumCompressionSize?: int, apiKeySource?: 'AUTHORIZER'|'HEADER', endpointConfiguration?: array{ types?: list<'EDGE'|'PRIVATE'|'REGIONAL'>, ipAddressType?: 'dualstack'|'ipv4', vpcEndpointIds?: list, ..., }, policy?: string, tags?: array<string, string>, disableExecuteApiEndpoint?: bool, securityPolicy?: 'SecurityPolicy_TLS12_2018_EDGE'|'SecurityPolicy_TLS12_PFS_2025_EDGE'|'SecurityPolicy_TLS13_1_2_2021_06'|'SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09'|'SecurityPolicy_TLS13_1_2_PQ_2025_09'|'SecurityPolicy_TLS13_1_3_2025_09'|'SecurityPolicy_TLS13_1_3_FIPS_2025_09'|'SecurityPolicy_TLS13_2025_EDGE'|'TLS_1_0'|'TLS_1_2', endpointAccessMode?: 'BASIC'|'STRICT', ..., } $args = [])

phpstan-method

\Aws\Result createStage(array{ restApiId?: string, stageName?: string, deploymentId?: string, description?: string, cacheClusterEnabled?: bool, cacheClusterSize?: '0.5'|'1.6'|'118'|'13.5'|'237'|'28.4'|'58.2'|'6.1', variables?: array<string, string>, documentationVersion?: string, canarySettings?: array{ percentTraffic?: float, deploymentId?: string, stageVariableOverrides?: array<string, string>, useStageCache?: bool, ..., }, tracingEnabled?: bool, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createStageAsync(array{ restApiId?: string, stageName?: string, deploymentId?: string, description?: string, cacheClusterEnabled?: bool, cacheClusterSize?: '0.5'|'1.6'|'118'|'13.5'|'237'|'28.4'|'58.2'|'6.1', variables?: array<string, string>, documentationVersion?: string, canarySettings?: array{ percentTraffic?: float, deploymentId?: string, stageVariableOverrides?: array<string, string>, useStageCache?: bool, ..., }, tracingEnabled?: bool, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result createUsagePlan(array{ name?: string, description?: string, apiStages?: list<array{apiId?: string, stage?: string, throttle?: array<string, array>, ...}>, throttle?: array{burstLimit?: int, rateLimit?: float, ...}, quota?: array{limit?: int, offset?: int, period?: 'DAY'|'MONTH'|'WEEK', ...}, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createUsagePlanAsync(array{ name?: string, description?: string, apiStages?: list<array{apiId?: string, stage?: string, throttle?: array<string, array>, ...}>, throttle?: array{burstLimit?: int, rateLimit?: float, ...}, quota?: array{limit?: int, offset?: int, period?: 'DAY'|'MONTH'|'WEEK', ...}, tags?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result createUsagePlanKey(array{usagePlanId?: string, keyId?: string, keyType?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createUsagePlanKeyAsync(array{usagePlanId?: string, keyId?: string, keyType?: string, ...} $args = [])

phpstan-method

\Aws\Result createVpcLink(array{name?: string, description?: string, targetArns?: list, tags?: array<string, string>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createVpcLinkAsync(array{name?: string, description?: string, targetArns?: list, tags?: array<string, string>, ...} $args = [])

phpstan-method

\Aws\Result deleteApiKey(array{apiKey?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteApiKeyAsync(array{apiKey?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAuthorizer(array{restApiId?: string, authorizerId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAuthorizerAsync(array{restApiId?: string, authorizerId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBasePathMapping(array{domainName?: string, domainNameId?: string, basePath?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBasePathMappingAsync(array{domainName?: string, domainNameId?: string, basePath?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteClientCertificate(array{clientCertificateId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteClientCertificateAsync(array{clientCertificateId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteDeployment(array{restApiId?: string, deploymentId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteDeploymentAsync(array{restApiId?: string, deploymentId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteDocumentationPart(array{restApiId?: string, documentationPartId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteDocumentationPartAsync(array{restApiId?: string, documentationPartId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteDocumentationVersion(array{restApiId?: string, documentationVersion?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteDocumentationVersionAsync(array{restApiId?: string, documentationVersion?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteDomainName(array{domainName?: string, domainNameId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteDomainNameAsync(array{domainName?: string, domainNameId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteDomainNameAccessAssociation(array{domainNameAccessAssociationArn?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteDomainNameAccessAssociationAsync(array{domainNameAccessAssociationArn?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteGatewayResponse(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteGatewayResponseAsync(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', ..., } $args = [])

phpstan-method

\Aws\Result deleteIntegration(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteIntegrationAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteIntegrationResponse(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteIntegrationResponseAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteMethod(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteMethodAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteMethodResponse(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteMethodResponseAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteModel(array{restApiId?: string, modelName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteModelAsync(array{restApiId?: string, modelName?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteRequestValidator(array{restApiId?: string, requestValidatorId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteRequestValidatorAsync(array{restApiId?: string, requestValidatorId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteResource(array{restApiId?: string, resourceId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteResourceAsync(array{restApiId?: string, resourceId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteRestApi(array{restApiId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteRestApiAsync(array{restApiId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteStage(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteStageAsync(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteUsagePlan(array{usagePlanId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteUsagePlanAsync(array{usagePlanId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteUsagePlanKey(array{usagePlanId?: string, keyId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteUsagePlanKeyAsync(array{usagePlanId?: string, keyId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteVpcLink(array{vpcLinkId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteVpcLinkAsync(array{vpcLinkId?: string, ...} $args = [])

phpstan-method

\Aws\Result flushStageAuthorizersCache(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise flushStageAuthorizersCacheAsync(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\Aws\Result flushStageCache(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise flushStageCacheAsync(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\Aws\Result generateClientCertificate(array{description?: string, tags?: array<string, string>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise generateClientCertificateAsync(array{description?: string, tags?: array<string, string>, ...} $args = [])

phpstan-method

\Aws\Result getAccount(array{...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccountAsync(array{...} $args = [])

phpstan-method

\Aws\Result getApiKey(array{apiKey?: string, includeValue?: bool, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getApiKeyAsync(array{apiKey?: string, includeValue?: bool, ...} $args = [])

phpstan-method

\Aws\Result getApiKeys(array{position?: string, limit?: int, nameQuery?: string, customerId?: string, includeValues?: bool, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getApiKeysAsync(array{position?: string, limit?: int, nameQuery?: string, customerId?: string, includeValues?: bool, ...} $args = [])

phpstan-method

\Aws\Result getAuthorizer(array{restApiId?: string, authorizerId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAuthorizerAsync(array{restApiId?: string, authorizerId?: string, ...} $args = [])

phpstan-method

\Aws\Result getAuthorizers(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAuthorizersAsync(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getBasePathMapping(array{domainName?: string, domainNameId?: string, basePath?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBasePathMappingAsync(array{domainName?: string, domainNameId?: string, basePath?: string, ...} $args = [])

phpstan-method

\Aws\Result getBasePathMappings(array{domainName?: string, domainNameId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBasePathMappingsAsync(array{domainName?: string, domainNameId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getClientCertificate(array{clientCertificateId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getClientCertificateAsync(array{clientCertificateId?: string, ...} $args = [])

phpstan-method

\Aws\Result getClientCertificates(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getClientCertificatesAsync(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getDeployment(array{restApiId?: string, deploymentId?: string, embed?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDeploymentAsync(array{restApiId?: string, deploymentId?: string, embed?: list, ...} $args = [])

phpstan-method

\Aws\Result getDeployments(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDeploymentsAsync(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getDocumentationPart(array{restApiId?: string, documentationPartId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDocumentationPartAsync(array{restApiId?: string, documentationPartId?: string, ...} $args = [])

phpstan-method

\Aws\Result getDocumentationParts(array{ restApiId?: string, type?: 'API'|'AUTHORIZER'|'METHOD'|'MODEL'|'PATH_PARAMETER'|'QUERY_PARAMETER'|'REQUEST_BODY'|'REQUEST_HEADER'|'RESOURCE'|'RESPONSE'|'RESPONSE_BODY'|'RESPONSE_HEADER', nameQuery?: string, path?: string, position?: string, limit?: int, locationStatus?: 'DOCUMENTED'|'UNDOCUMENTED', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDocumentationPartsAsync(array{ restApiId?: string, type?: 'API'|'AUTHORIZER'|'METHOD'|'MODEL'|'PATH_PARAMETER'|'QUERY_PARAMETER'|'REQUEST_BODY'|'REQUEST_HEADER'|'RESOURCE'|'RESPONSE'|'RESPONSE_BODY'|'RESPONSE_HEADER', nameQuery?: string, path?: string, position?: string, limit?: int, locationStatus?: 'DOCUMENTED'|'UNDOCUMENTED', ..., } $args = [])

phpstan-method

\Aws\Result getDocumentationVersion(array{restApiId?: string, documentationVersion?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDocumentationVersionAsync(array{restApiId?: string, documentationVersion?: string, ...} $args = [])

phpstan-method

\Aws\Result getDocumentationVersions(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDocumentationVersionsAsync(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getDomainName(array{domainName?: string, domainNameId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDomainNameAsync(array{domainName?: string, domainNameId?: string, ...} $args = [])

phpstan-method

\Aws\Result getDomainNameAccessAssociations(array{position?: string, limit?: int, resourceOwner?: 'OTHER_ACCOUNTS'|'SELF', ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDomainNameAccessAssociationsAsync(array{position?: string, limit?: int, resourceOwner?: 'OTHER_ACCOUNTS'|'SELF', ...} $args = [])

phpstan-method

\Aws\Result getDomainNames(array{position?: string, limit?: int, resourceOwner?: 'OTHER_ACCOUNTS'|'SELF', ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDomainNamesAsync(array{position?: string, limit?: int, resourceOwner?: 'OTHER_ACCOUNTS'|'SELF', ...} $args = [])

phpstan-method

\Aws\Result getExport(array{ restApiId?: string, stageName?: string, exportType?: string, parameters?: array<string, string>, accepts?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getExportAsync(array{ restApiId?: string, stageName?: string, exportType?: string, parameters?: array<string, string>, accepts?: string, ..., } $args = [])

phpstan-method

\Aws\Result getGatewayResponse(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getGatewayResponseAsync(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', ..., } $args = [])

phpstan-method

\Aws\Result getGatewayResponses(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getGatewayResponsesAsync(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getIntegration(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getIntegrationAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\Aws\Result getIntegrationResponse(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getIntegrationResponseAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\Aws\Result getMethod(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMethodAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, ...} $args = [])

phpstan-method

\Aws\Result getMethodResponse(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMethodResponseAsync(array{restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, ...} $args = [])

phpstan-method

\Aws\Result getModel(array{restApiId?: string, modelName?: string, flatten?: bool, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getModelAsync(array{restApiId?: string, modelName?: string, flatten?: bool, ...} $args = [])

phpstan-method

\Aws\Result getModelTemplate(array{restApiId?: string, modelName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getModelTemplateAsync(array{restApiId?: string, modelName?: string, ...} $args = [])

phpstan-method

\Aws\Result getModels(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getModelsAsync(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getRequestValidator(array{restApiId?: string, requestValidatorId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getRequestValidatorAsync(array{restApiId?: string, requestValidatorId?: string, ...} $args = [])

phpstan-method

\Aws\Result getRequestValidators(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getRequestValidatorsAsync(array{restApiId?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getResource(array{restApiId?: string, resourceId?: string, embed?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getResourceAsync(array{restApiId?: string, resourceId?: string, embed?: list, ...} $args = [])

phpstan-method

\Aws\Result getResources(array{restApiId?: string, position?: string, limit?: int, embed?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getResourcesAsync(array{restApiId?: string, position?: string, limit?: int, embed?: list, ...} $args = [])

phpstan-method

\Aws\Result getRestApi(array{restApiId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getRestApiAsync(array{restApiId?: string, ...} $args = [])

phpstan-method

\Aws\Result getRestApis(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getRestApisAsync(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getSdk(array{restApiId?: string, stageName?: string, sdkType?: string, parameters?: array<string, string>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getSdkAsync(array{restApiId?: string, stageName?: string, sdkType?: string, parameters?: array<string, string>, ...} $args = [])

phpstan-method

\Aws\Result getSdkType(array{id?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getSdkTypeAsync(array{id?: string, ...} $args = [])

phpstan-method

\Aws\Result getSdkTypes(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getSdkTypesAsync(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getStage(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getStageAsync(array{restApiId?: string, stageName?: string, ...} $args = [])

phpstan-method

\Aws\Result getStages(array{restApiId?: string, deploymentId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getStagesAsync(array{restApiId?: string, deploymentId?: string, ...} $args = [])

phpstan-method

\Aws\Result getTags(array{resourceArn?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getTagsAsync(array{resourceArn?: string, position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getUsage(array{ usagePlanId?: string, keyId?: string, startDate?: string, endDate?: string, position?: string, limit?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getUsageAsync(array{ usagePlanId?: string, keyId?: string, startDate?: string, endDate?: string, position?: string, limit?: int, ..., } $args = [])

phpstan-method

\Aws\Result getUsagePlan(array{usagePlanId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getUsagePlanAsync(array{usagePlanId?: string, ...} $args = [])

phpstan-method

\Aws\Result getUsagePlanKey(array{usagePlanId?: string, keyId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getUsagePlanKeyAsync(array{usagePlanId?: string, keyId?: string, ...} $args = [])

phpstan-method

\Aws\Result getUsagePlanKeys(array{usagePlanId?: string, position?: string, limit?: int, nameQuery?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getUsagePlanKeysAsync(array{usagePlanId?: string, position?: string, limit?: int, nameQuery?: string, ...} $args = [])

phpstan-method

\Aws\Result getUsagePlans(array{position?: string, keyId?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getUsagePlansAsync(array{position?: string, keyId?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result getVpcLink(array{vpcLinkId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getVpcLinkAsync(array{vpcLinkId?: string, ...} $args = [])

phpstan-method

\Aws\Result getVpcLinks(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getVpcLinksAsync(array{position?: string, limit?: int, ...} $args = [])

phpstan-method

\Aws\Result importApiKeys(array{body?: string|resource|\Psr\Http\Message\StreamInterface, format?: 'csv', failOnWarnings?: bool, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise importApiKeysAsync(array{body?: string|resource|\Psr\Http\Message\StreamInterface, format?: 'csv', failOnWarnings?: bool, ...} $args = [])

phpstan-method

\Aws\Result importDocumentationParts(array{ restApiId?: string, mode?: 'merge'|'overwrite', failOnWarnings?: bool, body?: string|resource|\Psr\Http\Message\StreamInterface, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise importDocumentationPartsAsync(array{ restApiId?: string, mode?: 'merge'|'overwrite', failOnWarnings?: bool, body?: string|resource|\Psr\Http\Message\StreamInterface, ..., } $args = [])

phpstan-method

\Aws\Result importRestApi(array{ failOnWarnings?: bool, parameters?: array<string, string>, body?: string|resource|\Psr\Http\Message\StreamInterface, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise importRestApiAsync(array{ failOnWarnings?: bool, parameters?: array<string, string>, body?: string|resource|\Psr\Http\Message\StreamInterface, ..., } $args = [])

phpstan-method

\Aws\Result putGatewayResponse(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', statusCode?: string, responseParameters?: array<string, string>, responseTemplates?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putGatewayResponseAsync(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', statusCode?: string, responseParameters?: array<string, string>, responseTemplates?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result putIntegration(array{ restApiId?: string, resourceId?: string, httpMethod?: string, type?: 'AWS'|'AWS_PROXY'|'HTTP'|'HTTP_PROXY'|'MOCK', integrationHttpMethod?: string, uri?: string, connectionType?: 'INTERNET'|'VPC_LINK', connectionId?: string, credentials?: string, requestParameters?: array<string, string>, requestTemplates?: array<string, string>, passthroughBehavior?: string, cacheNamespace?: string, cacheKeyParameters?: list, contentHandling?: 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT', timeoutInMillis?: int, tlsConfig?: array{insecureSkipVerification?: bool, ...}, responseTransferMode?: 'BUFFERED'|'STREAM', integrationTarget?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putIntegrationAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, type?: 'AWS'|'AWS_PROXY'|'HTTP'|'HTTP_PROXY'|'MOCK', integrationHttpMethod?: string, uri?: string, connectionType?: 'INTERNET'|'VPC_LINK', connectionId?: string, credentials?: string, requestParameters?: array<string, string>, requestTemplates?: array<string, string>, passthroughBehavior?: string, cacheNamespace?: string, cacheKeyParameters?: list, contentHandling?: 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT', timeoutInMillis?: int, tlsConfig?: array{insecureSkipVerification?: bool, ...}, responseTransferMode?: 'BUFFERED'|'STREAM', integrationTarget?: string, ..., } $args = [])

phpstan-method

\Aws\Result putIntegrationResponse(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, selectionPattern?: string, responseParameters?: array<string, string>, responseTemplates?: array<string, string>, contentHandling?: 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT', ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putIntegrationResponseAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, selectionPattern?: string, responseParameters?: array<string, string>, responseTemplates?: array<string, string>, contentHandling?: 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT', ..., } $args = [])

phpstan-method

\Aws\Result putMethod(array{ restApiId?: string, resourceId?: string, httpMethod?: string, authorizationType?: string, authorizerId?: string, apiKeyRequired?: bool, operationName?: string, requestParameters?: array<string, bool>, requestModels?: array<string, string>, requestValidatorId?: string, authorizationScopes?: list, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putMethodAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, authorizationType?: string, authorizerId?: string, apiKeyRequired?: bool, operationName?: string, requestParameters?: array<string, bool>, requestModels?: array<string, string>, requestValidatorId?: string, authorizationScopes?: list, ..., } $args = [])

phpstan-method

\Aws\Result putMethodResponse(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, responseParameters?: array<string, bool>, responseModels?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putMethodResponseAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, responseParameters?: array<string, bool>, responseModels?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result putRestApi(array{ restApiId?: string, mode?: 'merge'|'overwrite', failOnWarnings?: bool, parameters?: array<string, string>, body?: string|resource|\Psr\Http\Message\StreamInterface, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putRestApiAsync(array{ restApiId?: string, mode?: 'merge'|'overwrite', failOnWarnings?: bool, parameters?: array<string, string>, body?: string|resource|\Psr\Http\Message\StreamInterface, ..., } $args = [])

phpstan-method

\Aws\Result rejectDomainNameAccessAssociation(array{domainNameAccessAssociationArn?: string, domainNameArn?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise rejectDomainNameAccessAssociationAsync(array{domainNameAccessAssociationArn?: string, domainNameArn?: string, ...} $args = [])

phpstan-method

\Aws\Result tagResource(array{resourceArn?: string, tags?: array<string, string>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise tagResourceAsync(array{resourceArn?: string, tags?: array<string, string>, ...} $args = [])

phpstan-method

\Aws\Result testInvokeAuthorizer(array{ restApiId?: string, authorizerId?: string, headers?: array<string, string>, multiValueHeaders?: array<string, list>, pathWithQueryString?: string, body?: string, stageVariables?: array<string, string>, additionalContext?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise testInvokeAuthorizerAsync(array{ restApiId?: string, authorizerId?: string, headers?: array<string, string>, multiValueHeaders?: array<string, list>, pathWithQueryString?: string, body?: string, stageVariables?: array<string, string>, additionalContext?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result testInvokeMethod(array{ restApiId?: string, resourceId?: string, httpMethod?: string, pathWithQueryString?: string, body?: string, headers?: array<string, string>, multiValueHeaders?: array<string, list>, clientCertificateId?: string, stageVariables?: array<string, string>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise testInvokeMethodAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, pathWithQueryString?: string, body?: string, headers?: array<string, string>, multiValueHeaders?: array<string, list>, clientCertificateId?: string, stageVariables?: array<string, string>, ..., } $args = [])

phpstan-method

\Aws\Result untagResource(array{resourceArn?: string, tagKeys?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise untagResourceAsync(array{resourceArn?: string, tagKeys?: list, ...} $args = [])

phpstan-method

\Aws\Result updateAccount(array{ patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateAccountAsync(array{ patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateApiKey(array{ apiKey?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateApiKeyAsync(array{ apiKey?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateAuthorizer(array{ restApiId?: string, authorizerId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateAuthorizerAsync(array{ restApiId?: string, authorizerId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateBasePathMapping(array{ domainName?: string, domainNameId?: string, basePath?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateBasePathMappingAsync(array{ domainName?: string, domainNameId?: string, basePath?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateClientCertificate(array{ clientCertificateId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateClientCertificateAsync(array{ clientCertificateId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateDeployment(array{ restApiId?: string, deploymentId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateDeploymentAsync(array{ restApiId?: string, deploymentId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateDocumentationPart(array{ restApiId?: string, documentationPartId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateDocumentationPartAsync(array{ restApiId?: string, documentationPartId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateDocumentationVersion(array{ restApiId?: string, documentationVersion?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateDocumentationVersionAsync(array{ restApiId?: string, documentationVersion?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateDomainName(array{ domainName?: string, domainNameId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateDomainNameAsync(array{ domainName?: string, domainNameId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateGatewayResponse(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateGatewayResponseAsync(array{ restApiId?: string, responseType?: 'ACCESS_DENIED'|'API_CONFIGURATION_ERROR'|'AUTHORIZER_CONFIGURATION_ERROR'|'AUTHORIZER_FAILURE'|'BAD_REQUEST_BODY'|'BAD_REQUEST_PARAMETERS'|'DEFAULT_4XX'|'DEFAULT_5XX'|'EXPIRED_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'INVALID_API_KEY'|'INVALID_SIGNATURE'|'MISSING_AUTHENTICATION_TOKEN'|'QUOTA_EXCEEDED'|'REQUEST_TOO_LARGE'|'RESOURCE_NOT_FOUND'|'THROTTLED'|'UNAUTHORIZED'|'UNSUPPORTED_MEDIA_TYPE'|'WAF_FILTERED', patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateIntegration(array{ restApiId?: string, resourceId?: string, httpMethod?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateIntegrationAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateIntegrationResponse(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateIntegrationResponseAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateMethod(array{ restApiId?: string, resourceId?: string, httpMethod?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateMethodAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateMethodResponse(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateMethodResponseAsync(array{ restApiId?: string, resourceId?: string, httpMethod?: string, statusCode?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateModel(array{ restApiId?: string, modelName?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateModelAsync(array{ restApiId?: string, modelName?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateRequestValidator(array{ restApiId?: string, requestValidatorId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateRequestValidatorAsync(array{ restApiId?: string, requestValidatorId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateResource(array{ restApiId?: string, resourceId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateResourceAsync(array{ restApiId?: string, resourceId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateRestApi(array{ restApiId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateRestApiAsync(array{ restApiId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateStage(array{ restApiId?: string, stageName?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateStageAsync(array{ restApiId?: string, stageName?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateUsage(array{ usagePlanId?: string, keyId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateUsageAsync(array{ usagePlanId?: string, keyId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateUsagePlan(array{ usagePlanId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateUsagePlanAsync(array{ usagePlanId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result updateVpcLink(array{ vpcLinkId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateVpcLinkAsync(array{ vpcLinkId?: string, patchOperations?: list<array{op?: 'add'|'copy'|'move'|'remove'|'replace'|'test', path?: string, value?: string, from?: string, ...}>, ..., } $args = [])

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
_add_accept_header()  : 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

Methods

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

__sleep()

public __sleep() : mixed

_add_accept_header()

public static _add_accept_header(callable $handler) : mixed
Parameters
$handler : callable

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static

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> = []
Return values
CommandInterface

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.

Return values
mixed|null

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.

Return values
PromiseInterface

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
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.

Return values
HandlerList

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
Return values
string

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
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 -->
On this page