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

# Class NullCredentials

A blank set of credentials. AWS clients must be provided credentials, but there are some types of requests that do not need authentication. This class can be used to pivot on that scenario, and also serve as a mock credentials object when testing

  Aws\Common\Credentials\NullCredentials implements Aws\Common\Credentials\CredentialsInterface

Namespace: Aws\Common\Credentials
CodeCoverageIgnore
Located at Aws/Common/Credentials/NullCredentials.php

## Methods summary

- `public` `getAccessKeyId ( )`

  Returns the AWS access key ID for this credentials object.

- `public` `getSecretKey ( )`

  Returns the AWS secret access key for this credentials object.

- `public` `getSecurityToken ( )`

  Get the associated security token if available

- `public` `getExpiration ( )`

  Get the UNIX timestamp in which the credentials will expire

- `public` `isExpired ( )`

  Check if the credentials are expired

- `public` `serialize ( )`
- `public` `unserialize ( mixed $serialized )`
- `public` `setAccessKeyId ( string $key )`

  Set the AWS access key ID for this credentials object.

- `public` `setSecretKey ( string $secret )`

  Set the AWS secret access key for this credentials object.

- `public` `setSecurityToken ( string $token )`

  Set the security token to use with this credentials object

- `public` `setExpiration ( int $timestamp )`

  Set the UNIX timestamp in which the credentials will expire

## Methods detail

# `public string`
`getAccessKeyId( )`

Returns the AWS access key ID for this credentials object.

#### Returns

`string`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getAccessKeyId()`
# `public string`
`getSecretKey( )`

Returns the AWS secret access key for this credentials object.

#### Returns

`string`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getSecretKey()`
# `public string|null`
`getSecurityToken( )`

Get the associated security token if available

#### Returns

`string|null`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getSecurityToken()`
# `public integer|null`
`getExpiration( )`

Get the UNIX timestamp in which the credentials will expire

#### Returns

`integer|null`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getExpiration()`
# `public boolean`
`isExpired( )`

Check if the credentials are expired

#### Returns

`boolean`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::isExpired()`
# `public`
`serialize( )`

#### Implementation of

`Serializable::serialize()`
# `public`
`unserialize( mixed $serialized )`

#### Implementation of

`Serializable::unserialize()`
# `public `Aws\Common\Credentials\NullCredentials``
`setAccessKeyId( string $key )`

Set the AWS access key ID for this credentials object.

#### Parameters

$key
  `string`
  $key AWS access key ID

#### Returns

``Aws\Common\Credentials\NullCredentials``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setAccessKeyId()`
# `public `Aws\Common\Credentials\CredentialsInterface``
`setSecretKey( string $secret )`

Set the AWS secret access key for this credentials object.

#### Parameters

$secret
  `string`
  $secret AWS secret access key

#### Returns

``Aws\Common\Credentials\CredentialsInterface``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setSecretKey()`
# `public `Aws\Common\Credentials\NullCredentials``
`setSecurityToken( string $token )`

Set the security token to use with this credentials object

#### Parameters

$token
  `string`
  $token Security token

#### Returns

``Aws\Common\Credentials\NullCredentials``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setSecurityToken()`
# `public `Aws\Common\Credentials\NullCredentials``
`setExpiration( integer $timestamp )`

Set the UNIX timestamp in which the credentials will expire

#### Parameters

$timestamp
  `integer`
  $timestamp UNIX timestamp expiration

#### Returns

``Aws\Common\Credentials\NullCredentials``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setExpiration()`

### Magic methods summary