GetEnvironmentCredentialsCommand

Suggest an Edit

Gets the credentials of an environment in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, GetEnvironmentCredentialsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetEnvironmentCredentialsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetEnvironmentCredentialsInput
  domainIdentifier: "STRING_VALUE", // required
  environmentIdentifier: "STRING_VALUE", // required
};
const command = new GetEnvironmentCredentialsCommand(input);
const response = await client.send(command);
// { // GetEnvironmentCredentialsOutput
//   accessKeyId: "STRING_VALUE",
//   secretAccessKey: "STRING_VALUE",
//   sessionToken: "STRING_VALUE",
//   expiration: new Date("TIMESTAMP"),
// };

GetEnvironmentCredentialsCommand Input

See GetEnvironmentCredentialsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which this environment and its credentials exist.

environmentIdentifier
Required
string | undefined

The ID of the environment whose credentials this operation gets.

GetEnvironmentCredentialsCommand Output

See GetEnvironmentCredentialsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
accessKeyId
string | undefined

The access key ID of the environment.

expiration
Date | undefined

The expiration timestamp of the environment credentials.

secretAccessKey
string | undefined

The secret access key of the environment credentials.

sessionToken
string | undefined

The session token of the environment credentials.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.