Class: Aws::ForecastService::Types::S3Config

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Note:

When making an API call, you may pass S3Config data as a hash:

{
  path: "S3Path", # required
  role_arn: "Arn", # required
  kms_key_arn: "KMSKeyArn",
}

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object that is submitted in the CreateForecastExportJob request.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Returns:

  • (String) 


3266
3267
3268
3269
3270
3271
3272
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3266

class S3Config < Struct.new(
  :path,
  :role_arn,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Returns:

  • (String) 


3266
3267
3268
3269
3270
3271
3272
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3266

class S3Config < Struct.new(
  :path,
  :role_arn,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Returns:

  • (String) 


3266
3267
3268
3269
3270
3271
3272
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3266

class S3Config < Struct.new(
  :path,
  :role_arn,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end