NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Interface ServiceDescriptionInterface

A ServiceDescription stores service information based on a service document

  Guzzle\Service\Description\ServiceDescriptionInterface implements Serializable

### Direct known implementers

`Guzzle\Service\Description\ServiceDescription`

Namespace: Guzzle\Service\Description
Located at Guzzle/Service/Description/ServiceDescriptionInterface.php

## Methods summary

- `public` `getBaseUrl ( )`

  Get the basePath/baseUrl of the description

- `public` `getOperations ( )`

  Get the API operations of the service

- `public` `hasOperation ( string $name )`

  Check if the service has an operation by name

- `public` `getOperation ( string $name )`

  Get an API operation by name

- `public` `getModel ( string $id )`

  Get a specific model from the description

- `public` `getModels ( )`

  Get all service description models

- `public` `hasModel ( string $id )`

  Check if the description has a specific model by name

- `public` `getApiVersion ( )`

  Get the API version of the service

- `public` `getName ( )`

  Get the name of the API

- `public` `getDescription ( )`

  Get a summary of the purpose of the API

- `public` `getData ( string $key )`

  Get arbitrary data from the service description that is not part of the Guzzle spec

- `public` `setData ( string $key, mixed $value )`

  Set arbitrary data on the service description

## Methods detail

# `public string`
`getBaseUrl( )`

Get the basePath/baseUrl of the description

#### Returns

`string`
# `public array`
`getOperations( )`

Get the API operations of the service

#### Returns

`array`
Returns an array of `Guzzle\Service\Description\OperationInterface` objects
# `public boolean`
`hasOperation( string $name )`

Check if the service has an operation by name

#### Parameters

$name
  `string`
  $name Name of the operation to check

#### Returns

`boolean`
# `public `Guzzle\Service\Description\OperationInterface`|null`
`getOperation( string $name )`

Get an API operation by name

#### Parameters

$name
  `string`
  $name Name of the command

#### Returns

``Guzzle\Service\Description\OperationInterface`|null`
# `public `Guzzle\Service\Description\Parameter`|null`
`getModel( string $id )`

Get a specific model from the description

#### Parameters

$id
  `string`
  $id ID of the model

#### Returns

``Guzzle\Service\Description\Parameter`|null`
# `public array`
`getModels( )`

Get all service description models

#### Returns

`array`
# `public boolean`
`hasModel( string $id )`

Check if the description has a specific model by name

#### Parameters

$id
  `string`
  $id ID of the model

#### Returns

`boolean`
# `public string`
`getApiVersion( )`

Get the API version of the service

#### Returns

`string`
# `public string`
`getName( )`

Get the name of the API

#### Returns

`string`
# `public string`
`getDescription( )`

Get a summary of the purpose of the API

#### Returns

`string`
# `public null|mixed`
`getData( string $key )`

Get arbitrary data from the service description that is not part of the Guzzle spec

#### Parameters

$key
  `string`
  $key Data key to retrieve

#### Returns

`null|mixed`
# `public `Guzzle\Service\Description\ServiceDescriptionInterface``
`setData( string $key, mixed $value )`

Set arbitrary data on the service description

#### Parameters

$key
  `string`
  $key Data key to set
$value
  `mixed`
  $value Value to set

#### Returns

``Guzzle\Service\Description\ServiceDescriptionInterface``

### Methods inherited from Serializable

`serialize()`, `unserialize()`

### Magic methods summary