Class Service
- Aws\Api\AbstractModel implements ArrayAccess
-
Aws\Api\Service
- Namespace: Aws\Api
- Located at Api/Service.php
Represents a web service API model.
Methods Summary
- __construct ( array $definition, callable $provider )
-
static
createSerializer ( Aws\Api\Service $api, string $endpoint )
Creates a request serializer for the provided API object.
-
static
createErrorParser ( string $protocol, Aws\Api\Service $api = null )
Creates an error parser for the given protocol.
-
static
createParser ( Aws\Api\Service $api )
Applies the listeners needed to parse client models.
-
getServiceFullName ( )
Get the full name of the service
-
getServiceId ( )
Get the service id
-
getApiVersion ( )
Get the API version of the service
-
getEndpointPrefix ( )
Get the API version of the service
-
getSigningName ( )
Get the signing name used by the service.
-
getServiceName ( )
Get the service name.
-
getSignatureVersion ( )
Get the default signature version of the service.
-
getProtocol ( )
Get the protocol used by the service.
-
getUid ( )
Get the uid string used by the service
-
hasOperation ( string $name )
Check if the description has a specific operation by name.
-
getOperation ( string $name )
Get an operation by name.
-
getOperations ( )
Get all of the operations of the description.
-
getErrorShapes ( )
Get all of the error shapes of the service
-
getMetadata ( string|null $key = null )
Get all of the service metadata or a specific metadata key value.
-
getPaginators ( )
Gets an associative array of available paginator configurations where the key is the name of the paginator, and the value is the paginator configuration.
-
hasPaginator ( string $name )
Determines if the service has a paginator by name.
-
getPaginatorConfig ( string $name )
Retrieve a paginator by name.
-
getWaiters ( )
Gets an associative array of available waiter configurations where the key is the name of the waiter, and the value is the waiter configuration.
-
hasWaiter ( string $name )
Determines if the service has a waiter by name.
-
getWaiterConfig ( string $name )
Get a waiter configuration by name.
-
getShapeMap ( )
Get the shape map used by the API.
Methods inherited from Aws\Api\AbstractModel
Methods Details
__construct ( array $definition, callable $provider )
static
callable
createSerializer (
Aws\Api\Service
$api,
string
$endpoint
)
Creates a request serializer for the provided API object.
Parameters
Aws\Api\Service |
$api | API that contains a protocol. |
| string | $endpoint | Endpoint to send requests to. |
Returns
| callable |
Exceptions
| UnexpectedValueException |
static
callable
createErrorParser (
string
$protocol,
Aws\Api\Service
$api = null
)
Creates an error parser for the given protocol.
Redundant method signature to preserve backwards compatibility.
Parameters
| string | $protocol | Protocol to parse (e.g., query, json, etc.) |
Aws\Api\Service |
$api = null |
Returns
| callable |
Exceptions
| UnexpectedValueException |
static
callable
createParser (
Aws\Api\Service
$api
)
Applies the listeners needed to parse client models.
Parameters
Aws\Api\Service |
$api | API to create a parser for |
Returns
| callable |
Exceptions
| UnexpectedValueException |
string getServiceFullName ( )
Get the full name of the service
Returns
| string |
string getServiceId ( )
Get the service id
Returns
| string |
string getApiVersion ( )
Get the API version of the service
Returns
| string |
string getEndpointPrefix ( )
Get the API version of the service
Returns
| string |
string getSigningName ( )
Get the signing name used by the service.
Returns
| string |
string getServiceName ( )
Get the service name.
Returns
| string |
string getSignatureVersion ( )
Get the default signature version of the service.
Note: this method assumes "v4" when not specified in the model.
Returns
| string |
string getProtocol ( )
Get the protocol used by the service.
Returns
| string |
string getUid ( )
Get the uid string used by the service
Returns
| string |
boolean hasOperation ( string $name )
Check if the description has a specific operation by name.
Parameters
| string | $name | Operation to check by name |
Returns
| boolean |
Aws\Api\Operation
getOperation (
string
$name
)
Get an operation by name.
Parameters
| string | $name | Operation to retrieve by name |
Returns
Aws\Api\Operation |
Exceptions
| InvalidArgumentException If the operation is not found |
Aws\Api\Operation[]
getOperations (
)
array getErrorShapes ( )
Get all of the error shapes of the service
Returns
| array |
mixed getMetadata ( string|null $key = null )
Get all of the service metadata or a specific metadata key value.
Parameters
| string|null | $key = null | Key to retrieve or null to retrieve all metadata |
Returns
| mixed Returns the result or null if the key is not found |
array getPaginators ( )
Gets an associative array of available paginator configurations where the key is the name of the paginator, and the value is the paginator configuration.
Returns
| array |
Unstable
boolean hasPaginator ( string $name )
Determines if the service has a paginator by name.
Parameters
| string | $name | Name of the paginator. |
Returns
| boolean |
array getPaginatorConfig ( string $name )
Retrieve a paginator by name.
Parameters
| string | $name | Paginator to retrieve by name. This argument is typically the operation name. |
Returns
| array |
Exceptions
| UnexpectedValueException if the paginator does not exist. |
Unstable
array getWaiters ( )
Gets an associative array of available waiter configurations where the key is the name of the waiter, and the value is the waiter configuration.
Returns
| array |
boolean hasWaiter ( string $name )
Determines if the service has a waiter by name.
Parameters
| string | $name | Name of the waiter. |
Returns
| boolean |
array getWaiterConfig ( string $name )
Get a waiter configuration by name.
Parameters
| string | $name | Name of the waiter by name. |
Returns
| array |
Exceptions
| UnexpectedValueException if the waiter does not exist. |