翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# ListBackupJobs
<a name="API_ListBackupJobs"></a>

過去 30 日間の認証済みアカウントの既存のバックアップジョブのリストを返します。より長い期間については、これらの [モニタリングツール](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) を使用することを検討してください。

## リクエストの構文
<a name="API_ListBackupJobs_RequestSyntax"></a>

```
GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListBackupJobs_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByAccountId"></a>
ジョブを一覧表示するアカウント ID。指定されたアカウント ID に関連付けられたバックアップジョブのみを返します。  
 AWS Organizations 管理アカウントから使用する場合、 を渡すと組織全体のすべてのジョブ`*`が返されます。  
パターン: `^[0-9]{12}$` 

 ** [ByBackupVaultName](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByBackupVaultName"></a>
指定したバックアップボールトに保存されるバックアップジョブのみを返します。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [ByCompleteAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteAfter"></a>
Unix 形式および協定世界時 (UTC) で表された日付の後に完了したバックアップジョブのみを返します。

 ** [ByCompleteBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteBefore"></a>
Unix 形式および協定世界時 (UTC) で表される日付より前に完了したバックアップジョブのみを返します。

 ** [ByCreatedAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedAfter"></a>
指定した日付より後に作成されたバックアップジョブのみを返します。

 ** [ByCreatedBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedBefore"></a>
指定した日付より前に作成されたバックアップジョブのみを返します。

 ** [ByMessageCategory](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByMessageCategory"></a>
このオプションのパラメータを使用すると、MessageCategory が入力した値と一致するジョブを抽出できます。  
文字列の例としては `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL`、および `InvalidParameters` があります。  
「[モニタリング](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)」を参照してください。  
ワイルドカード () はすべてのメッセージカテゴリの数を返します。  
 `AGGREGATE_ALL` は、すべてのメッセージカテゴリのジョブ数を集計し、その合計を返します。

 ** [ByParentJobId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByParentJobId"></a>
親ジョブ ID に基づいて子 (ネストされた) ジョブを一覧表示するフィルターです。

 ** [ByResourceArn](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceArn"></a>
指定されたリソースの Amazon リソースネーム (ARN) に一致するバックアップジョブのみを返します。

 ** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceType"></a>
指定されたリソースのバックアップジョブのみを返します。  
+  Amazon Aurora の場合は `Aurora`
+  `CloudFormation` の AWS CloudFormation 
+  Amazon DocumentDB (MongoDB 互換性) の場合は `DocumentDB`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  `EKS` for Amazon Elastic Kubernetes Service
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon Redshift 用の `Redshift`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
+  Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の `SAP HANA on Amazon EC2`
+  `Storage Gateway` の AWS Storage Gateway 
+  Amazon Timestream 用の `Timestream`
+  VMware 仮想マシン用の `VirtualMachine`
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ByState](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByState"></a>
指定された状態にあるバックアップジョブのみを返します。  
 `Completed with issues` は AWS Backup コンソールでのみ表示されるステータスです。API の場合このステータスは、状態が `COMPLETED` で `MessageCategory` の値が `SUCCESS` 以外のジョブ、つまり完了はしているがステータスメッセージがあるジョブを指します。  
`Completed with issues` のジョブ数を取得するには、以下のように GET リクエストを 2 回実行し、2 つ目の小さい方の数字を引きます。  
GET /backup-jobs/?state=COMPLETED  
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED  
有効な値：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`

 ** [MaxResults](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListBackupJobs_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointLifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string",
         "VaultLockState": "string",
         "VaultType": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListBackupJobs_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupJobs](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-BackupJobs"></a>
JSON 形式で返されたバックアップジョブに関するメタデータを含む構造体の配列。  
型: [BackupJob](API_BackupJob.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupJobs_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupJobs_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobs)