GetUsageProfileCommand

Suggest an Edit

Retrieves information about the specified Glue usage profile.

Example Syntax

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

import { GlueClient, GetUsageProfileCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetUsageProfileCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetUsageProfileRequest
  Name: "STRING_VALUE", // required
};
const command = new GetUsageProfileCommand(input);
const response = await client.send(command);
// { // GetUsageProfileResponse
//   Name: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   Configuration: { // ProfileConfiguration
//     SessionConfiguration: { // ConfigurationMap
//       "<keys>": { // ConfigurationObject
//         DefaultValue: "STRING_VALUE",
//         AllowedValues: [ // AllowedValuesStringList
//           "STRING_VALUE",
//         ],
//         MinValue: "STRING_VALUE",
//         MaxValue: "STRING_VALUE",
//       },
//     },
//     JobConfiguration: {
//       "<keys>": {
//         DefaultValue: "STRING_VALUE",
//         AllowedValues: [
//           "STRING_VALUE",
//         ],
//         MinValue: "STRING_VALUE",
//         MaxValue: "STRING_VALUE",
//       },
//     },
//   },
//   CreatedOn: new Date("TIMESTAMP"),
//   LastModifiedOn: new Date("TIMESTAMP"),
// };

GetUsageProfileCommand Input

See GetUsageProfileCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the usage profile to retrieve.

GetUsageProfileCommand Output

See GetUsageProfileCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Configuration
ProfileConfiguration | undefined

A ProfileConfiguration object specifying the job and session values for the profile.

CreatedOn
Date | undefined

The date and time when the usage profile was created.

Description
string | undefined

A description of the usage profile.

LastModifiedOn
Date | undefined

The date and time when the usage profile was last modified.

Name
string | undefined

The name of the usage profile.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationNotSupportedException
client

The operation is not available in the region.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.