AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

batch-get-attached-file-metadata

Description

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

See also: AWS API Documentation

Synopsis

  batch-get-attached-file-metadata
--file-ids <value>
--instance-id <value>
--associated-resource-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--file-ids (list)

The unique identifiers of the attached file resource.

(string)

Syntax:

"string" "string" ...

--instance-id (string)

The unique identifier of the Connect instance.

--associated-resource-arn (string)

The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

Note

This value must be a valid ARN.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Files -> (list)

List of attached files that were successfully retrieved.

(structure)

Information about the attached file.

CreationTime -> (string)

The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ . For example, 2024-05-03T02:41:28.172Z .

FileArn -> (string)

The unique identifier of the attached file resource (ARN).

FileId -> (string)

The unique identifier of the attached file resource.

FileName -> (string)

A case-sensitive name of the attached file being uploaded.

FileSizeInBytes -> (long)

The size of the attached file in bytes.

FileStatus -> (string)

The current status of the attached file.

CreatedBy -> (tagged union structure)

Represents the identity that created the file.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ConnectUserArn, AWSIdentityArn.

ConnectUserArn -> (string)

An agent ARN representing a connect user .

AWSIdentityArn -> (string)

STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

FileUseCaseType -> (string)

The use case for the file.

AssociatedResourceArn -> (string)

The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

Note

This value must be a valid ARN.

Tags -> (map)

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} } .

key -> (string)

value -> (string)

Errors -> (list)

List of errors of attached files that could not be retrieved.

(structure)

Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.

ErrorCode -> (string)

Status code describing the failure.

ErrorMessage -> (string)

Why the attached file couldn't be retrieved.

FileId -> (string)

The unique identifier of the attached file resource.