# 使用状況プロファイル
<a name="aws-glue-api-usage-profiles"></a>

使用状況プロファイル API では、AWS Glue での使用状況プロファイルの作成、更新、表示に関連するデータ型と API について説明します。

## データ型
<a name="aws-glue-api-usage-profiles-objects"></a>
+ [ProfileConfiguration structure](#aws-glue-api-usage-profiles-ProfileConfiguration)
+ [ConfigurationObject structure](#aws-glue-api-usage-profiles-ConfigurationObject)
+ [UsageProfileDefinition structure](#aws-glue-api-usage-profiles-UsageProfileDefinition)

## ProfileConfiguration structure
<a name="aws-glue-api-usage-profiles-ProfileConfiguration"></a>

管理者が AWS Glue 使用状況プロファイルで設定するジョブとセッションの値を指定します。

**フィールド**
+ `SessionConfiguration` – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致します。

  各値は [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject) オブジェクトです。

  AWS Glue セッションの設定パラメータのキーと値のマップ。
+ `JobConfiguration` – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～255 バイト長で、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致します。

  各値は [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject) オブジェクトです。

  AWS Glue ジョブの設定パラメータのキーバリューマップ。

## ConfigurationObject structure
<a name="aws-glue-api-usage-profiles-ConfigurationObject"></a>

AWS Glue 使用状況プロファイルで設定されたジョブまたはセッションパラメータごとに管理者が設定する値を指定します。

**フィールド**
+ `DefaultValue` – UTF-8 文字列。1～128 バイト長。[Custom string pattern #35](aws-glue-api-common.md#regex_35) に一致。

  パラメータのデフォルト値。
+ `AllowedValues` – UTF-8 文字列の配列。

  パラメータの許容値リスト。
+ `MinValue` – UTF-8 文字列。1～128 バイト長。[Custom string pattern #35](aws-glue-api-common.md#regex_35) に一致。

  パラメータの最小許容値。
+ `MaxValue` – UTF-8 文字列。1～128 バイト長。[Custom string pattern #35](aws-glue-api-common.md#regex_35) に一致。

  パラメータの最大許容値。

## UsageProfileDefinition structure
<a name="aws-glue-api-usage-profiles-UsageProfileDefinition"></a>

AWS Glue 使用状況プロファイルについて説明します。

**フィールド**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  使用状況プロファイルの名前。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。

  使用状況プロファイルの説明。
+ `CreatedOn` – タイムスタンプ。

  使用状況プロファイルが作成された日時。
+ `LastModifiedOn` – タイムスタンプ。

  使用状況プロファイルの最終変更日時。

## 操作
<a name="aws-glue-api-usage-profiles-actions"></a>
+ [CreateUsageProfile action (Python: create\$1usage\$1profile)](#aws-glue-api-usage-profiles-CreateUsageProfile)
+ [GetUsageProfile action (Python: get\$1usage\$1profile)](#aws-glue-api-usage-profiles-GetUsageProfile)
+ [UpdateUsageProfile action (Python: update\$1usage\$1profile)](#aws-glue-api-usage-profiles-UpdateUsageProfile)
+ [DeleteUsageProfile action (Python: delete\$1usage\$1profile)](#aws-glue-api-usage-profiles-DeleteUsageProfile)
+ [ListUsageProfiles action (Python: list\$1usage\$1profiles)](#aws-glue-api-usage-profiles-ListUsageProfiles)

## CreateUsageProfile action (Python: create\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-CreateUsageProfile"></a>

AWS Glue 使用状況プロファイルを作成します。

**リクエスト**
+ `Name` – *必須:* UTF-8 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。

  使用状況プロファイルの名前。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。

  使用状況プロファイルの説明。
+ `Configuration` – *必須:* [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration) オブジェクト。

  プロファイルのジョブ値とセッション値を指定する `ProfileConfiguration` オブジェクト。
+ `Tags` – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  使用状況プロファイルに適用されるタグのリスト。

**レスポンス**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  作成された使用状況プロファイルの名前。

**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `OperationNotSupportedException`

## GetUsageProfile action (Python: get\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-GetUsageProfile"></a>

指定された AWS Glue 使用状況プロファイルに関する情報を取得します。

**リクエスト**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  取得する使用状況プロファイルの名前。

**レスポンス**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  使用状況プロファイルの名前。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。

  使用状況プロファイルの説明。
+ `Configuration` – [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration) オブジェクト。

  プロファイルのジョブ値とセッション値を指定する `ProfileConfiguration` オブジェクト。
+ `CreatedOn` – タイムスタンプ。

  使用状況プロファイルが作成された日時。
+ `LastModifiedOn` – タイムスタンプ。

  使用状況プロファイルの最終変更日時。

**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## UpdateUsageProfile action (Python: update\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-UpdateUsageProfile"></a>

AWS Glue 使用状況プロファイルを更新します。

**リクエスト**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  使用状況プロファイルの名前。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。

  使用状況プロファイルの説明。
+ `Configuration` – *必須:* [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration) オブジェクト。

  プロファイルのジョブ値とセッション値を指定する `ProfileConfiguration` オブジェクト。

**レスポンス**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  更新された使用状況プロファイルの名前。

**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`
+ `ConcurrentModificationException`

## DeleteUsageProfile action (Python: delete\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-DeleteUsageProfile"></a>

AWS Glue の指定された使用状況プロファイルを削除します。

**リクエスト**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。

  削除された使用状況プロファイルの名前。

**レスポンス**
+ *応答パラメータはありません。*

**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## ListUsageProfiles action (Python: list\$1usage\$1profiles)
<a name="aws-glue-api-usage-profiles-ListUsageProfiles"></a>

すべての AWS Glue 使用状況プロファイルを一覧表示します。

**リクエスト**
+ `NextToken` - UTF-8 文字列。400,000 バイト長以下。

  継続トークン (これが継続呼び出しの場合)。
+ `MaxResults` – 1 未満または 200 を超えない数値 (整数)。

  1 回の応答で返される使用状況プロファイルの最大数。

**応答**
+ `Profiles` – [UsageProfileDefinition](#aws-glue-api-usage-profiles-UsageProfileDefinition) オブジェクトの配列。

  使用状況プロファイル (`UsageProfileDefinition`) オブジェクトのリスト。
+ `NextToken` - UTF-8 文字列。400,000 バイト長以下。

  継続トークン (現在のリストセグメントが最後ではない場合に存在)。

**エラー**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `OperationNotSupportedException`