You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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 submitted in the CreateDatasetImportJob and CreateForecastExportJob requests.

See Also:

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) 


2751
2752
2753
2754
2755
2756
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2751

class S3Config < Struct.new(
  :path,
  :role_arn,
  :kms_key_arn)
  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) 


2751
2752
2753
2754
2755
2756
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2751

class S3Config < Struct.new(
  :path,
  :role_arn,
  :kms_key_arn)
  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 file(s).

Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an InvalidInputException is thrown.

Returns:

  • (String) 


2751
2752
2753
2754
2755
2756
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2751

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