- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetJobTaggingCommand
Returns the tags on an S3 Batch Operations job.
- Permissions
-
To use the
GetJobTaggingoperation, you must have permission to perform thes3:GetJobTaggingaction. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { S3ControlClient, GetJobTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import
// const { S3ControlClient, GetJobTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import
const client = new S3ControlClient(config);
const input = { // GetJobTaggingRequest
AccountId: "STRING_VALUE",
JobId: "STRING_VALUE", // required
};
const command = new GetJobTaggingCommand(input);
const response = await client.send(command);
// { // GetJobTaggingResult
// Tags: [ // S3TagSet
// { // S3Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// };
GetJobTaggingCommand Input
See GetJobTaggingCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
JobIdRequired | string | undefined | The ID for the S3 Batch Operations job whose tags you want to retrieve. |
AccountId | string | undefined | The Amazon Web Services account ID associated with the S3 Batch Operations job. |
GetJobTaggingCommand Output
See GetJobTaggingCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Tags | S3Tag[] | undefined | The set of tags associated with the S3 Batch Operations job. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | |
| NotFoundException | client | |
| TooManyRequestsException | client | |
| S3ControlServiceException | Base exception class for all service exceptions from S3Control service. |