logo

Retrieve an AWS SES credential

Retrieves an AWS SES credential with a specified token ID.

SecuritySecretApiKey or JWT
Request
path Parameters
hash
required
string

ID of the token.

Responses
200

AWS SES credential retrieved.

Response Schema: application/json
key
required
string

ID of the AWS access key.

secret
required
string

Secret AWS access key.

region
required
string

AWS region name.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

configurationSetName
string

Name of configuration set from which emails are sent.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/credential-hashes/aws-ses/{hash}
Request samples 
const details = await api.credentialHashes.getAWSSESCredential({hash: 'foobar-001'});
console.log(details.fields.configurationSetName);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "key": "BWITYO4UARGDLMFY6UDP",
  • "secret": "8D34yYHOK9+yM7pDnNUO3UTO/5b8Wy/PGNyzTRmG",
  • "region": "us-west-2",
  • "configurationSetName": "SpecialConfigurationSet",
  • "_links": [
    ]
}
➔ Next to Update an AWS SES credential