CreateUsageProfileCommand

Creates an Glue usage profile.

Example Syntax

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

import { GlueClient, CreateUsageProfileCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, CreateUsageProfileCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // CreateUsageProfileRequest
  Name: "STRING_VALUE", // required
  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",
      },
    },
  },
  Tags: { // TagsMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateUsageProfileCommand(input);
const response = await client.send(command);
// { // CreateUsageProfileResponse
//   Name: "STRING_VALUE",
// };

CreateUsageProfileCommand Input

See CreateUsageProfileCommandInput for more details

Parameter
Type
Description
Configuration
Required
ProfileConfiguration | undefined

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

Name
Required
string | undefined

The name of the usage profile.

Description
string | undefined

A description of the usage profile.

Tags
Record<string, string> | undefined

A list of tags applied to the usage profile.

CreateUsageProfileCommand Output

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

The name of the usage profile that was created.

Throws

Name
Fault
Details
AlreadyExistsException
client

A resource to be created or added already exists.

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.

ResourceNumberLimitExceededException
client

A resource numerical limit was exceeded.

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