AWS SDK for PHP 3.x (original) (raw)

Get all transfer information as an associative array if no nameargumentissupplied,orgetsaspecifictransferstatisticifaname argument is supplied, or gets a specific transfer statistic if a nameargumentissupplied,orgetsaspecifictransferstatisticifaname attribute is supplied (e.g., 'retries_attempted').

hasKey() : mixed

isConnectionError() : bool

Returns true if this is a connection error.

isMaxRetriesExceeded() : bool

Returns whether the max number of retries is exceeded.

offsetExists() : bool

offsetGet() : mixed|null

This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').

offsetSet() : void

offsetUnset() : void

prependMonitoringEvent() : mixed

Prepend a client-side monitoring event to this object's event list

search() : mixed

setMaxRetriesExceeded() : mixed

Sets the flag for max number of retries exceeded.

setTransferInfo() : mixed

Replace the transfer information associated with an exception.

toArray() : mixed

__construct()

public __construct(string <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>m</mi><mi>e</mi><mi>s</mi><mi>s</mi><mi>a</mi><mi>g</mi><mi>e</mi><mo separator="true">,</mo><mo stretchy="false">[</mo><mi>C</mi><mi>o</mi><mi>m</mi><mi>m</mi><mi>a</mi><mi>n</mi><mi>d</mi><mi>I</mi><mi>n</mi><mi>t</mi><mi>e</mi><mi>r</mi><mi>f</mi><mi>a</mi><mi>c</mi><mi>e</mi><mo stretchy="false">]</mo><mo stretchy="false">(</mo><mi>c</mi><mi>l</mi><mi>a</mi><mi>s</mi><mi>s</mi><mo>−</mo><mi>A</mi><mi>w</mi><mi>s</mi><mi mathvariant="normal">.</mi><mi>C</mi><mi>o</mi><mi>m</mi><mi>m</mi><mi>a</mi><mi>n</mi><mi>d</mi><mi>I</mi><mi>n</mi><mi>t</mi><mi>e</mi><mi>r</mi><mi>f</mi><mi>a</mi><mi>c</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>h</mi><mi>t</mi><mi>m</mi><mi>l</mi><mo stretchy="false">)</mo></mrow><annotation encoding="application/x-tex">message, [CommandInterface](class-Aws.CommandInterface.html) </annotation></semantics></math>message,[CommandInterface](class−Aws.CommandInterface.html)command[, array<string|int, mixed> <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>c</mi><mi>o</mi><mi>n</mi><mi>t</mi><mi>e</mi><mi>x</mi><mi>t</mi><mo>=</mo><mo stretchy="false">[</mo><mo stretchy="false">]</mo><mo stretchy="false">]</mo><mo stretchy="false">[</mo><mo separator="true">,</mo><mi>E</mi><mi>x</mi><mi>c</mi><mi>e</mi><mi>p</mi><mi>t</mi><mi>i</mi><mi>o</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">context = [] ][, Exception </annotation></semantics></math>context=[]][,Exceptionprevious = null ]) : mixed

Parameters

$message : string

Exception message

$command : CommandInterface

$context : array<string|int, mixed> = []

Exception context

$previous : Exception = null

Previous exception (if any)

__toString()

public __toString() : mixed

appendMonitoringEvent()

Append a client-side monitoring event to this object's event list

public appendMonitoringEvent(array<string|int, mixed> $event) : mixed

Parameters

$event : array<string|int, mixed>

count()

public count() : int

Return values

int

get()

public get(mixed $key) : mixed

Parameters

$key : mixed

getAwsErrorCode()

Get the AWS error code.

public getAwsErrorCode() : string|null

Return values

string|null —

Returns null if no response was received

getAwsErrorMessage()

Get the concise error message if any.

public getAwsErrorMessage() : string|null

Return values

string|null

getAwsErrorShape()

Get the AWS error shape.

public getAwsErrorShape() : [Shape](class-Aws.Api.Shape.html)|null

Return values

Shape|null —

Returns null if no response was received

getAwsErrorType()

Get the AWS error type.

public getAwsErrorType() : string|null

Return values

string|null —

Returns null if no response was received

getAwsRequestId()

Get the request ID of the error. This value is only present if a response was received and is not present in the event of a networking error.

public getAwsRequestId() : string|null

Return values

string|null —

Returns null if no response was received

getCommand()

Get the command that was executed.

public getCommand() : [CommandInterface](class-Aws.CommandInterface.html)

Return values

CommandInterface

getIterator()

public getIterator() : Traversable

Return values

Traversable

getMonitoringEvents()

Get client-side monitoring events attached to this object. Each event is represented as an associative array within the returned array.

public getMonitoringEvents() : array<string|int, mixed>

Return values

array<string|int, mixed>

getRequest()

Get the sent HTTP request if any.

public getRequest() : [RequestInterface](class-Psr.Http.Message.RequestInterface.html)|null

Return values

RequestInterface|null

getResponse()

Get the received HTTP response if any.

public getResponse() : [ResponseInterface](class-Psr.Http.Message.ResponseInterface.html)|null

Return values

ResponseInterface|null

getResult()

Get the result of the exception if available

public getResult() : [ResultInterface](class-Aws.ResultInterface.html)|null

Return values

ResultInterface|null

getStatusCode()

If available, gets the HTTP status code of the corresponding response

public getStatusCode() : int|null

Return values

int|null

getTransferInfo()

public getTransferInfo([string $name = null ]) : mixed|null|array<string|int, mixed>

Parameters

$name : string = null

Name of the transfer stat to retrieve

Return values

mixed|null|array<string|int, mixed>

hasKey()

public hasKey(mixed $name) : mixed

Parameters

$name : mixed

isConnectionError()

Returns true if this is a connection error.

public isConnectionError() : bool

Return values

bool

isMaxRetriesExceeded()

Returns whether the max number of retries is exceeded.

public isMaxRetriesExceeded() : bool

Return values

bool

offsetExists()

public offsetExists(mixed $offset) : bool

Parameters

$offset : mixed

Return values

bool

offsetGet()

This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').

public & offsetGet( $offset) : mixed|null

Parameters

$offset :

Return values

mixed|null

offsetSet()

public offsetSet(mixed <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>o</mi><mi>f</mi><mi>f</mi><mi>s</mi><mi>e</mi><mi>t</mi><mo separator="true">,</mo><mi>m</mi><mi>i</mi><mi>x</mi><mi>e</mi><mi>d</mi></mrow><annotation encoding="application/x-tex">offset, mixed </annotation></semantics></math>offset,mixedvalue) : void

Parameters

$offset : mixed

$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : void

Parameters

$offset : mixed

prependMonitoringEvent()

Prepend a client-side monitoring event to this object's event list

public prependMonitoringEvent(array<string|int, mixed> $event) : mixed

Parameters

$event : array<string|int, mixed>

search()

public search(mixed $expression) : mixed

Parameters

$expression : mixed

setMaxRetriesExceeded()

Sets the flag for max number of retries exceeded.

public setMaxRetriesExceeded() : mixed

setTransferInfo()

Replace the transfer information associated with an exception.

public setTransferInfo(array<string|int, mixed> $info) : mixed

Parameters

$info : array<string|int, mixed>

toArray()

public toArray() : mixed

AWS SDK for PHP 3.x (original) (raw)

S3ControlException extends AwsException

Table of Contents

Methods

__construct()

Parameters

__toString()

appendMonitoringEvent()

Parameters

count()

Return values

get()

Parameters

getAwsErrorCode()

Return values

getAwsErrorMessage()

Return values

getAwsErrorShape()

Return values

getAwsErrorType()

Return values

getAwsRequestId()

Return values

getCommand()

Return values

getIterator()

Return values

getMonitoringEvents()

Return values

getRequest()

Return values

getResponse()

Return values

getResult()

Return values

getStatusCode()

Return values

getTransferInfo()

Parameters

Return values

hasKey()

Parameters

isConnectionError()

Return values

isMaxRetriesExceeded()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

prependMonitoringEvent()

Parameters

search()

Parameters

setMaxRetriesExceeded()

setTransferInfo()

Parameters

toArray()