# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::RedshiftServerless module Types # You do not have sufficient access to perform this action. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :code, :message) SENSITIVE = [] include Aws::Structure end # An array of key-value pairs to set for advanced control over Amazon # Redshift Serverless. # # @note When making an API call, you may pass ConfigParameter # data as a hash: # # { # parameter_key: "ParameterKey", # parameter_value: "ParameterValue", # } # # @!attribute [rw] parameter_key # The key of the parameter. The options are `datestyle`, # `enable_user_activity_logging`, `query_group`, `search_path`, and # `max_query_execution_time`. # @return [String] # # @!attribute [rw] parameter_value # The value of the parameter to set. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ConfigParameter AWS API Documentation # class ConfigParameter < Struct.new( :parameter_key, :parameter_value) SENSITIVE = [] include Aws::Structure end # The submitted action has conflicts. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ConvertRecoveryPointToSnapshotRequest # data as a hash: # # { # recovery_point_id: "String", # required # retention_period: 1, # snapshot_name: "String", # required # } # # @!attribute [rw] recovery_point_id # The unique identifier of the recovery point. # @return [String] # # @!attribute [rw] retention_period # How long to retain the snapshot. # @return [Integer] # # @!attribute [rw] snapshot_name # The name of the snapshot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshotRequest AWS API Documentation # class ConvertRecoveryPointToSnapshotRequest < Struct.new( :recovery_point_id, :retention_period, :snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # The snapshot converted from the recovery point. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshotResponse AWS API Documentation # class ConvertRecoveryPointToSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateEndpointAccessRequest # data as a hash: # # { # endpoint_name: "String", # required # subnet_ids: ["SubnetId"], # required # vpc_security_group_ids: ["VpcSecurityGroupId"], # workgroup_name: "String", # required # } # # @!attribute [rw] endpoint_name # The name of the VPC endpoint. An endpoint name must contain 1-30 # characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The # first character must be a letter. The name can't contain two # consecutive hyphens or end with a hyphen. # @return [String] # # @!attribute [rw] subnet_ids # The unique identifers of subnets from which Amazon Redshift # Serverless chooses one to deploy a VPC endpoint. # @return [Array] # # @!attribute [rw] vpc_security_group_ids # The unique identifiers of the security group that defines the ports, # protocols, and sources for inbound traffic that you are authorizing # into your endpoint. # @return [Array] # # @!attribute [rw] workgroup_name # The name of the workgroup to associate with the VPC endpoint. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateEndpointAccessRequest AWS API Documentation # class CreateEndpointAccessRequest < Struct.new( :endpoint_name, :subnet_ids, :vpc_security_group_ids, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] endpoint # The created VPC endpoint. # @return [Types::EndpointAccess] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateEndpointAccessResponse AWS API Documentation # class CreateEndpointAccessResponse < Struct.new( :endpoint) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateNamespaceRequest # data as a hash: # # { # admin_user_password: "DbPassword", # admin_username: "DbUser", # db_name: "String", # default_iam_role_arn: "String", # iam_roles: ["IamRoleArn"], # kms_key_id: "String", # log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog # namespace_name: "NamespaceName", # required # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] admin_user_password # The password of the administrator for the first database created in # the namespace. # @return [String] # # @!attribute [rw] admin_username # The username of the administrator for the first database created in # the namespace. # @return [String] # # @!attribute [rw] db_name # The name of the first database created in the namespace. # @return [String] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) of the IAM role to set as a default # in the namespace. # @return [String] # # @!attribute [rw] iam_roles # A list of IAM roles to associate with the namespace. # @return [Array] # # @!attribute [rw] kms_key_id # The ID of the Amazon Web Services Key Management Service key used to # encrypt your data. # @return [String] # # @!attribute [rw] log_exports # The types of logs the namespace can export. Available export types # are `userlog`, `connectionlog`, and `useractivitylog`. # @return [Array] # # @!attribute [rw] namespace_name # The name of the namespace. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateNamespaceRequest AWS API Documentation # class CreateNamespaceRequest < Struct.new( :admin_user_password, :admin_username, :db_name, :default_iam_role_arn, :iam_roles, :kms_key_id, :log_exports, :namespace_name, :tags) SENSITIVE = [:admin_user_password, :admin_username] include Aws::Structure end # @!attribute [rw] namespace # The created namespace object. # @return [Types::Namespace] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateNamespaceResponse AWS API Documentation # class CreateNamespaceResponse < Struct.new( :namespace) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateSnapshotRequest # data as a hash: # # { # namespace_name: "String", # required # retention_period: 1, # snapshot_name: "String", # required # } # # @!attribute [rw] namespace_name # The namespace to create a snapshot for. # @return [String] # # @!attribute [rw] retention_period # How long to retain the created snapshot. # @return [Integer] # # @!attribute [rw] snapshot_name # The name of the snapshot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateSnapshotRequest AWS API Documentation # class CreateSnapshotRequest < Struct.new( :namespace_name, :retention_period, :snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # The created snapshot object. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateSnapshotResponse AWS API Documentation # class CreateSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateUsageLimitRequest # data as a hash: # # { # amount: 1, # required # breach_action: "log", # accepts log, emit-metric, deactivate # period: "daily", # accepts daily, weekly, monthly # resource_arn: "String", # required # usage_type: "serverless-compute", # required, accepts serverless-compute, cross-region-datasharing # } # # @!attribute [rw] amount # The limit amount. If time-based, this amount is in Redshift # Processing Units (RPU) consumed per hour. If data-based, this amount # is in terabytes (TB) of data transferred between Regions in # cross-account sharing. The value must be a positive number. # @return [Integer] # # @!attribute [rw] breach_action # The action that Amazon Redshift Serverless takes when the limit is # reached. The default is log. # @return [String] # # @!attribute [rw] period # The time period that the amount applies to. A weekly period begins # on Sunday. The default is monthly. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the Amazon Redshift Serverless # resource to create the usage limit for. # @return [String] # # @!attribute [rw] usage_type # The type of Amazon Redshift Serverless usage to create a usage limit # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateUsageLimitRequest AWS API Documentation # class CreateUsageLimitRequest < Struct.new( :amount, :breach_action, :period, :resource_arn, :usage_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] usage_limit # The returned usage limit object. # @return [Types::UsageLimit] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateUsageLimitResponse AWS API Documentation # class CreateUsageLimitResponse < Struct.new( :usage_limit) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateWorkgroupRequest # data as a hash: # # { # base_capacity: 1, # config_parameters: [ # { # parameter_key: "ParameterKey", # parameter_value: "ParameterValue", # }, # ], # enhanced_vpc_routing: false, # namespace_name: "NamespaceName", # required # publicly_accessible: false, # security_group_ids: ["SecurityGroupId"], # subnet_ids: ["SubnetId"], # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] base_capacity # The base data warehouse capacity of the workgroup in Redshift # Processing Units (RPUs). # @return [Integer] # # @!attribute [rw] config_parameters # An array of parameters to set for more control over a serverless # database. The options are `datestyle`, # `enable_user_activity_logging`, `query_group`, `search_path`, and # `max_query_execution_time`. # @return [Array] # # @!attribute [rw] enhanced_vpc_routing # The value that specifies whether to turn on enhanced virtual private # cloud (VPC) routing, which forces Amazon Redshift Serverless to # route traffic through your VPC instead of over the internet. # @return [Boolean] # # @!attribute [rw] namespace_name # The name of the namespace to associate with the workgroup. # @return [String] # # @!attribute [rw] publicly_accessible # A value that specifies whether the workgroup can be accessed from a # public network. # @return [Boolean] # # @!attribute [rw] security_group_ids # An array of security group IDs to associate with the workgroup. # @return [Array] # # @!attribute [rw] subnet_ids # An array of VPC subnet IDs to associate with the workgroup. # @return [Array] # # @!attribute [rw] tags # A array of tag instances. # @return [Array] # # @!attribute [rw] workgroup_name # The name of the created workgroup. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateWorkgroupRequest AWS API Documentation # class CreateWorkgroupRequest < Struct.new( :base_capacity, :config_parameters, :enhanced_vpc_routing, :namespace_name, :publicly_accessible, :security_group_ids, :subnet_ids, :tags, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] workgroup # The created workgroup object. # @return [Types::Workgroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/CreateWorkgroupResponse AWS API Documentation # class CreateWorkgroupResponse < Struct.new( :workgroup) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteEndpointAccessRequest # data as a hash: # # { # endpoint_name: "String", # required # } # # @!attribute [rw] endpoint_name # The name of the VPC endpoint to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteEndpointAccessRequest AWS API Documentation # class DeleteEndpointAccessRequest < Struct.new( :endpoint_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] endpoint # The deleted VPC endpoint. # @return [Types::EndpointAccess] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteEndpointAccessResponse AWS API Documentation # class DeleteEndpointAccessResponse < Struct.new( :endpoint) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteNamespaceRequest # data as a hash: # # { # final_snapshot_name: "String", # final_snapshot_retention_period: 1, # namespace_name: "NamespaceName", # required # } # # @!attribute [rw] final_snapshot_name # The name of the snapshot to be created before the namespace is # deleted. # @return [String] # # @!attribute [rw] final_snapshot_retention_period # How long to retain the final snapshot. # @return [Integer] # # @!attribute [rw] namespace_name # The name of the namespace to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteNamespaceRequest AWS API Documentation # class DeleteNamespaceRequest < Struct.new( :final_snapshot_name, :final_snapshot_retention_period, :namespace_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] namespace # The deleted namespace object. # @return [Types::Namespace] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteNamespaceResponse AWS API Documentation # class DeleteNamespaceResponse < Struct.new( :namespace) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteResourcePolicyRequest # data as a hash: # # { # resource_arn: "String", # required # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the policy to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteResourcePolicyRequest AWS API Documentation # class DeleteResourcePolicyRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteResourcePolicyResponse AWS API Documentation # class DeleteResourcePolicyResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass DeleteSnapshotRequest # data as a hash: # # { # snapshot_name: "String", # required # } # # @!attribute [rw] snapshot_name # The name of the snapshot to be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteSnapshotRequest AWS API Documentation # class DeleteSnapshotRequest < Struct.new( :snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # The deleted snapshot object. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteSnapshotResponse AWS API Documentation # class DeleteSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteUsageLimitRequest # data as a hash: # # { # usage_limit_id: "String", # required # } # # @!attribute [rw] usage_limit_id # The unique identifier of the usage limit to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteUsageLimitRequest AWS API Documentation # class DeleteUsageLimitRequest < Struct.new( :usage_limit_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] usage_limit # The deleted usage limit object. # @return [Types::UsageLimit] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteUsageLimitResponse AWS API Documentation # class DeleteUsageLimitResponse < Struct.new( :usage_limit) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteWorkgroupRequest # data as a hash: # # { # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] workgroup_name # The name of the workgroup to be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteWorkgroupRequest AWS API Documentation # class DeleteWorkgroupRequest < Struct.new( :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] workgroup # The deleted workgroup object. # @return [Types::Workgroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/DeleteWorkgroupResponse AWS API Documentation # class DeleteWorkgroupResponse < Struct.new( :workgroup) SENSITIVE = [] include Aws::Structure end # The VPC endpoint object. # # @!attribute [rw] address # The DNS address of the VPC endpoint. # @return [String] # # @!attribute [rw] port # The port that Amazon Redshift Serverless listens on. # @return [Integer] # # @!attribute [rw] vpc_endpoints # An array of `VpcEndpoint` objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/Endpoint AWS API Documentation # class Endpoint < Struct.new( :address, :port, :vpc_endpoints) SENSITIVE = [] include Aws::Structure end # Information about an Amazon Redshift Serverless VPC endpoint. # # @!attribute [rw] address # The DNS address of the endpoint. # @return [String] # # @!attribute [rw] endpoint_arn # The Amazon Resource Name (ARN) of the VPC endpoint. # @return [String] # # @!attribute [rw] endpoint_create_time # The time that the endpoint was created. # @return [Time] # # @!attribute [rw] endpoint_name # The name of the VPC endpoint. # @return [String] # # @!attribute [rw] endpoint_status # The status of the VPC endpoint. # @return [String] # # @!attribute [rw] port # The port number on which Amazon Redshift Serverless accepts incoming # connections. # @return [Integer] # # @!attribute [rw] subnet_ids # The unique identifier of subnets where Amazon Redshift Serverless # choose to deploy the VPC endpoint. # @return [Array] # # @!attribute [rw] vpc_endpoint # The connection endpoint for connecting to Amazon Redshift # Serverless. # @return [Types::VpcEndpoint] # # @!attribute [rw] vpc_security_groups # The security groups associated with the endpoint. # @return [Array] # # @!attribute [rw] workgroup_name # The name of the workgroup associated with the endpoint. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/EndpointAccess AWS API Documentation # class EndpointAccess < Struct.new( :address, :endpoint_arn, :endpoint_create_time, :endpoint_name, :endpoint_status, :port, :subnet_ids, :vpc_endpoint, :vpc_security_groups, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetCredentialsRequest # data as a hash: # # { # db_name: "DbName", # duration_seconds: 1, # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] db_name # The name of the database to get temporary authorization to log on # to. # # Constraints: # # * Must be 1 to 64 alphanumeric characters or hyphens. # # * Must contain only lowercase letters, numbers, underscore, plus # sign, period (dot), at symbol (@), or hyphen. # # * The first character must be a letter. # # * Must not contain a colon ( : ) or slash ( / ). # # * Cannot be a reserved word. A list of reserved words can be found # in [Reserved Words ][1] in the Amazon Redshift Database Developer # Guide # # # # [1]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [String] # # @!attribute [rw] duration_seconds # The number of seconds until the returned temporary password expires. # The minimum is 900 seconds, and the maximum is 3600 seconds. # @return [Integer] # # @!attribute [rw] workgroup_name # The name of the workgroup associated with the database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetCredentialsRequest AWS API Documentation # class GetCredentialsRequest < Struct.new( :db_name, :duration_seconds, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] db_password # A temporary password that authorizes the user name returned by # `DbUser` to log on to the database `DbName`. # @return [String] # # @!attribute [rw] db_user # A database user name that is authorized to log on to the database # `DbName` using the password `DbPassword`. If the specified `DbUser` # exists in the database, the new user name has the same database # privileges as the the user named in `DbUser`. By default, the user # is added to PUBLIC. # @return [String] # # @!attribute [rw] expiration # The date and time the password in `DbPassword` expires. # @return [Time] # # @!attribute [rw] next_refresh_time # The date and time of when the `DbUser` and `DbPassword` # authorization refreshes. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetCredentialsResponse AWS API Documentation # class GetCredentialsResponse < Struct.new( :db_password, :db_user, :expiration, :next_refresh_time) SENSITIVE = [:db_password, :db_user] include Aws::Structure end # @note When making an API call, you may pass GetEndpointAccessRequest # data as a hash: # # { # endpoint_name: "String", # required # } # # @!attribute [rw] endpoint_name # The name of the VPC endpoint to return information for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetEndpointAccessRequest AWS API Documentation # class GetEndpointAccessRequest < Struct.new( :endpoint_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] endpoint # The returned VPC endpoint. # @return [Types::EndpointAccess] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetEndpointAccessResponse AWS API Documentation # class GetEndpointAccessResponse < Struct.new( :endpoint) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetNamespaceRequest # data as a hash: # # { # namespace_name: "NamespaceName", # required # } # # @!attribute [rw] namespace_name # The name of the namespace to retrieve information for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetNamespaceRequest AWS API Documentation # class GetNamespaceRequest < Struct.new( :namespace_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] namespace # The returned namespace object. # @return [Types::Namespace] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetNamespaceResponse AWS API Documentation # class GetNamespaceResponse < Struct.new( :namespace) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetRecoveryPointRequest # data as a hash: # # { # recovery_point_id: "String", # required # } # # @!attribute [rw] recovery_point_id # The unique identifier of the recovery point to return information # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetRecoveryPointRequest AWS API Documentation # class GetRecoveryPointRequest < Struct.new( :recovery_point_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] recovery_point # The returned recovery point object. # @return [Types::RecoveryPoint] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetRecoveryPointResponse AWS API Documentation # class GetRecoveryPointResponse < Struct.new( :recovery_point) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetResourcePolicyRequest # data as a hash: # # { # resource_arn: "String", # required # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetResourcePolicyRequest AWS API Documentation # class GetResourcePolicyRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_policy # The returned resource policy. # @return [Types::ResourcePolicy] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetResourcePolicyResponse AWS API Documentation # class GetResourcePolicyResponse < Struct.new( :resource_policy) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetSnapshotRequest # data as a hash: # # { # owner_account: "String", # snapshot_arn: "String", # snapshot_name: "String", # } # # @!attribute [rw] owner_account # The owner Amazon Web Services account of a snapshot shared with # another user. # @return [String] # # @!attribute [rw] snapshot_arn # The Amazon Resource Name (ARN) of the snapshot to return. # @return [String] # # @!attribute [rw] snapshot_name # The name of the snapshot to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetSnapshotRequest AWS API Documentation # class GetSnapshotRequest < Struct.new( :owner_account, :snapshot_arn, :snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # The returned snapshot object. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetSnapshotResponse AWS API Documentation # class GetSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetUsageLimitRequest # data as a hash: # # { # usage_limit_id: "String", # required # } # # @!attribute [rw] usage_limit_id # The unique identifier of the usage limit to return information for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetUsageLimitRequest AWS API Documentation # class GetUsageLimitRequest < Struct.new( :usage_limit_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] usage_limit # The returned usage limit object. # @return [Types::UsageLimit] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetUsageLimitResponse AWS API Documentation # class GetUsageLimitResponse < Struct.new( :usage_limit) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetWorkgroupRequest # data as a hash: # # { # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] workgroup_name # The name of the workgroup to return information for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetWorkgroupRequest AWS API Documentation # class GetWorkgroupRequest < Struct.new( :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] workgroup # The returned workgroup object. # @return [Types::Workgroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetWorkgroupResponse AWS API Documentation # class GetWorkgroupResponse < Struct.new( :workgroup) SENSITIVE = [] include Aws::Structure end # There is an insufficient capacity to perform the action. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/InsufficientCapacityException AWS API Documentation # class InsufficientCapacityException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The request processing has failed because of an unknown error, # exception or failure. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/InternalServerException AWS API Documentation # class InternalServerException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The provided pagination token is invalid. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/InvalidPaginationException AWS API Documentation # class InvalidPaginationException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListEndpointAccessRequest # data as a hash: # # { # max_results: 1, # next_token: "String", # vpc_id: "String", # workgroup_name: "String", # } # # @!attribute [rw] max_results # An optional parameter that specifies the maximum number of results # to return. You can use `nextToken` to get the next page of results. # @return [Integer] # # @!attribute [rw] next_token # If your initial `ListEndpointAccess` operation returns a # `nextToken`, you can include the returned `nextToken` in subsequent # `ListEndpointAccess` operations, which returns results in the next # page. # @return [String] # # @!attribute [rw] vpc_id # The unique identifier of the virtual private cloud with access to # Amazon Redshift Serverless. # @return [String] # # @!attribute [rw] workgroup_name # The name of the workgroup associated with the VPC endpoint to # return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListEndpointAccessRequest AWS API Documentation # class ListEndpointAccessRequest < Struct.new( :max_results, :next_token, :vpc_id, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] endpoints # The returned VPC endpoints. # @return [Array] # # @!attribute [rw] next_token # When `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. # Make the call again using the returned token to retrieve the next # page. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListEndpointAccessResponse AWS API Documentation # class ListEndpointAccessResponse < Struct.new( :endpoints, :next_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListNamespacesRequest # data as a hash: # # { # max_results: 1, # next_token: "String", # } # # @!attribute [rw] max_results # An optional parameter that specifies the maximum number of results # to return. You can use `nextToken` to get the next page of results. # @return [Integer] # # @!attribute [rw] next_token # If your initial `ListNamespaces` operation returns a `nextToken`, # you can include the returned `nextToken` in subsequent # `ListNamespaces` operations, which returns results in the next page. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListNamespacesRequest AWS API Documentation # class ListNamespacesRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] namespaces # The list of returned namespaces. # @return [Array] # # @!attribute [rw] next_token # When `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. # Make the call again using the returned token to retrieve the next # page. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListNamespacesResponse AWS API Documentation # class ListNamespacesResponse < Struct.new( :namespaces, :next_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListRecoveryPointsRequest # data as a hash: # # { # end_time: Time.now, # max_results: 1, # namespace_name: "NamespaceName", # next_token: "String", # start_time: Time.now, # } # # @!attribute [rw] end_time # The time when creation of the recovery point finished. # @return [Time] # # @!attribute [rw] max_results # An optional parameter that specifies the maximum number of results # to return. You can use `nextToken` to get the next page of results. # @return [Integer] # # @!attribute [rw] namespace_name # The name of the namespace to list recovery points for. # @return [String] # # @!attribute [rw] next_token # If your initial `ListRecoveryPoints` operation returns a # `nextToken`, you can include the returned `nextToken` in subsequent # `ListRecoveryPoints` operations, which returns results in the next # page. # @return [String] # # @!attribute [rw] start_time # The time when the recovery point's creation was initiated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListRecoveryPointsRequest AWS API Documentation # class ListRecoveryPointsRequest < Struct.new( :end_time, :max_results, :namespace_name, :next_token, :start_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # If `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. # Make the call again using the returned token to retrieve the next # page. # @return [String] # # @!attribute [rw] recovery_points # The returned recovery point objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListRecoveryPointsResponse AWS API Documentation # class ListRecoveryPointsResponse < Struct.new( :next_token, :recovery_points) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListSnapshotsRequest # data as a hash: # # { # end_time: Time.now, # max_results: 1, # namespace_arn: "String", # namespace_name: "String", # next_token: "String", # owner_account: "String", # start_time: Time.now, # } # # @!attribute [rw] end_time # The timestamp showing when the snapshot creation finished. # @return [Time] # # @!attribute [rw] max_results # An optional parameter that specifies the maximum number of results # to return. You can use `nextToken` to get the next page of results. # @return [Integer] # # @!attribute [rw] namespace_arn # The Amazon Resource Name (ARN) of the namespace from which to list # all snapshots. # @return [String] # # @!attribute [rw] namespace_name # The namespace from which to list all snapshots. # @return [String] # # @!attribute [rw] next_token # If `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. # Make the call again using the returned token to retrieve the next # page. # @return [String] # # @!attribute [rw] owner_account # The owner Amazon Web Services account of the snapshot. # @return [String] # # @!attribute [rw] start_time # The time when the creation of the snapshot was initiated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListSnapshotsRequest AWS API Documentation # class ListSnapshotsRequest < Struct.new( :end_time, :max_results, :namespace_arn, :namespace_name, :next_token, :owner_account, :start_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # If `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. # Make the call again using the returned token to retrieve the next # page. # @return [String] # # @!attribute [rw] snapshots # All of the returned snapshot objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListSnapshotsResponse AWS API Documentation # class ListSnapshotsResponse < Struct.new( :next_token, :snapshots) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListTagsForResourceRequest # data as a hash: # # { # resource_arn: "AmazonResourceName", # required # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to list tags for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] tags # A map of the key-value pairs assigned to the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListUsageLimitsRequest # data as a hash: # # { # max_results: 1, # next_token: "PaginationToken", # resource_arn: "String", # usage_type: "serverless-compute", # accepts serverless-compute, cross-region-datasharing # } # # @!attribute [rw] max_results # An optional parameter that specifies the maximum number of results # to return. You can use `nextToken` to get the next page of results. # The default is 100. # @return [Integer] # # @!attribute [rw] next_token # If your initial `ListUsageLimits` operation returns a `nextToken`, # you can include the returned `nextToken` in subsequent # `ListUsageLimits` operations, which returns results in the next # page. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) associated with the resource whose # usage limits you want to list. # @return [String] # # @!attribute [rw] usage_type # The Amazon Redshift Serverless feature whose limits you want to see. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListUsageLimitsRequest AWS API Documentation # class ListUsageLimitsRequest < Struct.new( :max_results, :next_token, :resource_arn, :usage_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # When `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. # Make the call again using the returned token to retrieve the next # page. # @return [String] # # @!attribute [rw] usage_limits # An array of returned usage limit objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListUsageLimitsResponse AWS API Documentation # class ListUsageLimitsResponse < Struct.new( :next_token, :usage_limits) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ListWorkgroupsRequest # data as a hash: # # { # max_results: 1, # next_token: "String", # } # # @!attribute [rw] max_results # An optional parameter that specifies the maximum number of results # to return. You can use `nextToken` to get the next page of results. # @return [Integer] # # @!attribute [rw] next_token # If your initial ListWorkgroups operation returns a `nextToken`, you # can include the returned `nextToken` in subsequent ListNamespaces # operations, which returns results in the next page. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListWorkgroupsRequest AWS API Documentation # class ListWorkgroupsRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # If `nextToken` is returned, there are more results available. The # value of `nextToken` is a unique pagination token for each page. To # retrieve the next page, make the call again using the returned # token. # @return [String] # # @!attribute [rw] workgroups # The returned array of workgroups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListWorkgroupsResponse AWS API Documentation # class ListWorkgroupsResponse < Struct.new( :next_token, :workgroups) SENSITIVE = [] include Aws::Structure end # A collection of database objects and users. # # @!attribute [rw] admin_username # The username of the administrator for the first database created in # the namespace. # @return [String] # # @!attribute [rw] creation_date # The date of when the namespace was created. # @return [Time] # # @!attribute [rw] db_name # The name of the first database created in the namespace. # @return [String] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) of the IAM role to set as a default # in the namespace. # @return [String] # # @!attribute [rw] iam_roles # A list of IAM roles to associate with the namespace. # @return [Array] # # @!attribute [rw] kms_key_id # The ID of the Amazon Web Services Key Management Service key used to # encrypt your data. # @return [String] # # @!attribute [rw] log_exports # The types of logs the namespace can export. Available export types # are User log, Connection log, and User activity log. # @return [Array] # # @!attribute [rw] namespace_arn # The Amazon Resource Name (ARN) associated with a namespace. # @return [String] # # @!attribute [rw] namespace_id # The unique identifier of a namespace. # @return [String] # # @!attribute [rw] namespace_name # The name of the namespace. Must be between 3-64 alphanumeric # characters in lowercase, and it cannot be a reserved word. A list of # reserved words can be found in [Reserved Words][1] in the Amazon # Redshift Database Developer Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [String] # # @!attribute [rw] status # The status of the namespace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/Namespace AWS API Documentation # class Namespace < Struct.new( :admin_username, :creation_date, :db_name, :default_iam_role_arn, :iam_roles, :kms_key_id, :log_exports, :namespace_arn, :namespace_id, :namespace_name, :status) SENSITIVE = [:admin_username] include Aws::Structure end # Contains information about a network interface in an Amazon Redshift # Serverless managed VPC endpoint. # # @!attribute [rw] availability_zone # The availability Zone. # @return [String] # # @!attribute [rw] network_interface_id # The unique identifier of the network interface. # @return [String] # # @!attribute [rw] private_ip_address # The IPv4 address of the network interface within the subnet. # @return [String] # # @!attribute [rw] subnet_id # The unique identifier of the subnet. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/NetworkInterface AWS API Documentation # class NetworkInterface < Struct.new( :availability_zone, :network_interface_id, :private_ip_address, :subnet_id) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PutResourcePolicyRequest # data as a hash: # # { # policy: "String", # required # resource_arn: "String", # required # } # # @!attribute [rw] policy # The policy to create or update. For example, the following policy # grants a user authorization to restore a snapshot. # # `"\{"Version": "2012-10-17", "Statement" : [\{ "Sid": # "AllowUserRestoreFromSnapshot", "Principal":\{"AWS": # ["739247239426"]\}, "Action": # ["redshift-serverless:RestoreFromSnapshot"] , "Effect": # "Allow" \}]\}"` # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the account to create or update a # resource policy for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/PutResourcePolicyRequest AWS API Documentation # class PutResourcePolicyRequest < Struct.new( :policy, :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_policy # The policy that was created or updated. # @return [Types::ResourcePolicy] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/PutResourcePolicyResponse AWS API Documentation # class PutResourcePolicyResponse < Struct.new( :resource_policy) SENSITIVE = [] include Aws::Structure end # The automatically created recovery point of a namespace. Recovery # points are created every 30 minutes and kept for 24 hours. # # @!attribute [rw] namespace_name # The name of the namespace the recovery point is associated with. # @return [String] # # @!attribute [rw] recovery_point_create_time # The time the recovery point is created. # @return [Time] # # @!attribute [rw] recovery_point_id # The unique identifier of the recovery point. # @return [String] # # @!attribute [rw] total_size_in_mega_bytes # The total size of the data in the recovery point in megabytes. # @return [Float] # # @!attribute [rw] workgroup_name # The name of the workgroup the recovery point is associated with. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RecoveryPoint AWS API Documentation # class RecoveryPoint < Struct.new( :namespace_name, :recovery_point_create_time, :recovery_point_id, :total_size_in_mega_bytes, :workgroup_name) SENSITIVE = [] include Aws::Structure end # The resource could not be found. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_name # The name of the resource that could not be found. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message, :resource_name) SENSITIVE = [] include Aws::Structure end # The resource policy object. Currently, you can use policies to share # snapshots across Amazon Web Services accounts. # # @!attribute [rw] policy # The resource policy. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the policy. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ResourcePolicy AWS API Documentation # class ResourcePolicy < Struct.new( :policy, :resource_arn) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RestoreFromRecoveryPointRequest # data as a hash: # # { # namespace_name: "NamespaceName", # required # recovery_point_id: "String", # required # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] namespace_name # The name of the namespace to restore data into. # @return [String] # # @!attribute [rw] recovery_point_id # The unique identifier of the recovery point to restore from. # @return [String] # # @!attribute [rw] workgroup_name # The name of the workgroup used to restore data. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RestoreFromRecoveryPointRequest AWS API Documentation # class RestoreFromRecoveryPointRequest < Struct.new( :namespace_name, :recovery_point_id, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] namespace # The namespace that data was restored into. # @return [Types::Namespace] # # @!attribute [rw] recovery_point_id # The unique identifier of the recovery point used for the restore. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RestoreFromRecoveryPointResponse AWS API Documentation # class RestoreFromRecoveryPointResponse < Struct.new( :namespace, :recovery_point_id) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RestoreFromSnapshotRequest # data as a hash: # # { # namespace_name: "NamespaceName", # required # owner_account: "String", # snapshot_arn: "String", # snapshot_name: "String", # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] namespace_name # The name of the namespace to restore the snapshot to. # @return [String] # # @!attribute [rw] owner_account # The Amazon Web Services account that owns the snapshot. # @return [String] # # @!attribute [rw] snapshot_arn # The Amazon Resource Name (ARN) of the snapshot to restore from. # @return [String] # # @!attribute [rw] snapshot_name # The name of the snapshot to restore from. # @return [String] # # @!attribute [rw] workgroup_name # The name of the workgroup used to restore the snapshot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RestoreFromSnapshotRequest AWS API Documentation # class RestoreFromSnapshotRequest < Struct.new( :namespace_name, :owner_account, :snapshot_arn, :snapshot_name, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] namespace # A collection of database objects and users. # @return [Types::Namespace] # # @!attribute [rw] owner_account # The owner Amazon Web Services; account of the snapshot that was # restored. # @return [String] # # @!attribute [rw] snapshot_name # The name of the snapshot used to restore the namespace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/RestoreFromSnapshotResponse AWS API Documentation # class RestoreFromSnapshotResponse < Struct.new( :namespace, :owner_account, :snapshot_name) SENSITIVE = [] include Aws::Structure end # The service limit was exceeded. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A snapshot object that contains databases. # # @!attribute [rw] accounts_with_provisioned_restore_access # All of the Amazon Web Services accounts that have access to restore # a snapshot to a provisioned cluster. # @return [Array] # # @!attribute [rw] accounts_with_restore_access # All of the Amazon Web Services accounts that have access to restore # a snapshot to a namespace. # @return [Array] # # @!attribute [rw] actual_incremental_backup_size_in_mega_bytes # The size of the incremental backup in megabytes. # @return [Float] # # @!attribute [rw] admin_username # The username of the database within a snapshot. # @return [String] # # @!attribute [rw] backup_progress_in_mega_bytes # The size in megabytes of the data that has been backed up to a # snapshot. # @return [Float] # # @!attribute [rw] current_backup_rate_in_mega_bytes_per_second # The rate at which data is backed up into a snapshot in megabytes per # second. # @return [Float] # # @!attribute [rw] elapsed_time_in_seconds # The amount of time it took to back up data into a snapshot. # @return [Integer] # # @!attribute [rw] estimated_seconds_to_completion # The estimated amount of seconds until the snapshot completes backup. # @return [Integer] # # @!attribute [rw] kms_key_id # The unique identifier of the KMS key used to encrypt the snapshot. # @return [String] # # @!attribute [rw] namespace_arn # The Amazon Resource Name (ARN) of the namespace the snapshot was # created from. # @return [String] # # @!attribute [rw] namespace_name # The name of the namepsace. # @return [String] # # @!attribute [rw] owner_account # The owner Amazon Web Services; account of the snapshot. # @return [String] # # @!attribute [rw] snapshot_arn # The Amazon Resource Name (ARN) of the snapshot. # @return [String] # # @!attribute [rw] snapshot_create_time # The timestamp of when the snapshot was created. # @return [Time] # # @!attribute [rw] snapshot_name # The name of the snapshot. # @return [String] # # @!attribute [rw] snapshot_remaining_days # The amount of days until the snapshot is deleted. # @return [Integer] # # @!attribute [rw] snapshot_retention_period # The period of time, in days, of how long the snapshot is retained. # @return [Integer] # # @!attribute [rw] snapshot_retention_start_time # The timestamp of when data within the snapshot started getting # retained. # @return [Time] # # @!attribute [rw] status # The status of the snapshot. # @return [String] # # @!attribute [rw] total_backup_size_in_mega_bytes # The total size, in megabytes, of how big the snapshot is. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/Snapshot AWS API Documentation # class Snapshot < Struct.new( :accounts_with_provisioned_restore_access, :accounts_with_restore_access, :actual_incremental_backup_size_in_mega_bytes, :admin_username, :backup_progress_in_mega_bytes, :current_backup_rate_in_mega_bytes_per_second, :elapsed_time_in_seconds, :estimated_seconds_to_completion, :kms_key_id, :namespace_arn, :namespace_name, :owner_account, :snapshot_arn, :snapshot_create_time, :snapshot_name, :snapshot_remaining_days, :snapshot_retention_period, :snapshot_retention_start_time, :status, :total_backup_size_in_mega_bytes) SENSITIVE = [] include Aws::Structure end # A map of key-value pairs. # # @note When making an API call, you may pass Tag # data as a hash: # # { # key: "TagKey", # required # value: "TagValue", # required # } # # @!attribute [rw] key # The key to use in the tag. # @return [String] # # @!attribute [rw] value # The value of the tag. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/Tag AWS API Documentation # class Tag < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass TagResourceRequest # data as a hash: # # { # resource_arn: "AmazonResourceName", # required # tags: [ # required # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to tag. # @return [String] # # @!attribute [rw] tags # The map of the key-value pairs used to tag the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # The request was denied due to request throttling. # # @!attribute [rw] code # @return [String] # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ThrottlingException AWS API Documentation # class ThrottlingException < Struct.new( :code, :message) SENSITIVE = [] include Aws::Structure end # The request exceeded the number of tags allowed for a resource. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_name # The name of the resource that exceeded the number of tags allowed # for a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/TooManyTagsException AWS API Documentation # class TooManyTagsException < Struct.new( :message, :resource_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UntagResourceRequest # data as a hash: # # { # resource_arn: "AmazonResourceName", # required # tag_keys: ["TagKey"], # required # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to remove tags from. # @return [String] # # @!attribute [rw] tag_keys # The tag or set of tags to remove from the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass UpdateEndpointAccessRequest # data as a hash: # # { # endpoint_name: "String", # required # vpc_security_group_ids: ["VpcSecurityGroupId"], # } # # @!attribute [rw] endpoint_name # The name of the VPC endpoint to update. # @return [String] # # @!attribute [rw] vpc_security_group_ids # The list of VPC security groups associated with the endpoint after # the endpoint is modified. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateEndpointAccessRequest AWS API Documentation # class UpdateEndpointAccessRequest < Struct.new( :endpoint_name, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] endpoint # The updated VPC endpoint. # @return [Types::EndpointAccess] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateEndpointAccessResponse AWS API Documentation # class UpdateEndpointAccessResponse < Struct.new( :endpoint) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateNamespaceRequest # data as a hash: # # { # admin_user_password: "DbPassword", # admin_username: "DbUser", # default_iam_role_arn: "String", # iam_roles: ["IamRoleArn"], # kms_key_id: "String", # log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog # namespace_name: "NamespaceName", # required # } # # @!attribute [rw] admin_user_password # The password of the administrator for the first database created in # the namespace. # @return [String] # # @!attribute [rw] admin_username # The username of the administrator for the first database created in # the namespace. # @return [String] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) of the IAM role to set as a default # in the namespace. # @return [String] # # @!attribute [rw] iam_roles # A list of IAM roles to associate with the namespace. # @return [Array] # # @!attribute [rw] kms_key_id # The ID of the Amazon Web Services Key Management Service key used to # encrypt your data. # @return [String] # # @!attribute [rw] log_exports # The types of logs the namespace can export. The export types are # `userlog`, `connectionlog`, and `useractivitylog`. # @return [Array] # # @!attribute [rw] namespace_name # The name of the namespace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateNamespaceRequest AWS API Documentation # class UpdateNamespaceRequest < Struct.new( :admin_user_password, :admin_username, :default_iam_role_arn, :iam_roles, :kms_key_id, :log_exports, :namespace_name) SENSITIVE = [:admin_user_password, :admin_username] include Aws::Structure end # @!attribute [rw] namespace # A list of tag instances. # @return [Types::Namespace] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateNamespaceResponse AWS API Documentation # class UpdateNamespaceResponse < Struct.new( :namespace) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateSnapshotRequest # data as a hash: # # { # retention_period: 1, # snapshot_name: "String", # required # } # # @!attribute [rw] retention_period # The new retention period of the snapshot. # @return [Integer] # # @!attribute [rw] snapshot_name # The name of the snapshot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateSnapshotRequest AWS API Documentation # class UpdateSnapshotRequest < Struct.new( :retention_period, :snapshot_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # The updated snapshot object. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateSnapshotResponse AWS API Documentation # class UpdateSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateUsageLimitRequest # data as a hash: # # { # amount: 1, # breach_action: "log", # accepts log, emit-metric, deactivate # usage_limit_id: "String", # required # } # # @!attribute [rw] amount # The new limit amount. For more information about this parameter. # @return [Integer] # # @!attribute [rw] breach_action # The new action that Amazon Redshift Serverless takes when the limit # is reached. # @return [String] # # @!attribute [rw] usage_limit_id # The identifier of the usage limit to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateUsageLimitRequest AWS API Documentation # class UpdateUsageLimitRequest < Struct.new( :amount, :breach_action, :usage_limit_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] usage_limit # The updated usage limit object. # @return [Types::UsageLimit] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateUsageLimitResponse AWS API Documentation # class UpdateUsageLimitResponse < Struct.new( :usage_limit) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass UpdateWorkgroupRequest # data as a hash: # # { # base_capacity: 1, # config_parameters: [ # { # parameter_key: "ParameterKey", # parameter_value: "ParameterValue", # }, # ], # enhanced_vpc_routing: false, # publicly_accessible: false, # security_group_ids: ["SecurityGroupId"], # subnet_ids: ["SubnetId"], # workgroup_name: "WorkgroupName", # required # } # # @!attribute [rw] base_capacity # The new base data warehouse capacity in Redshift Processing Units # (RPUs). # @return [Integer] # # @!attribute [rw] config_parameters # An array of parameters to set for advanced control over a database. # The options are `datestyle`, `enable_user_activity_logging`, # `query_group`, `search_path`, and `max_query_execution_time`. # @return [Array] # # @!attribute [rw] enhanced_vpc_routing # The value that specifies whether to turn on enhanced virtual private # cloud (VPC) routing, which forces Amazon Redshift Serverless to # route traffic through your VPC. # @return [Boolean] # # @!attribute [rw] publicly_accessible # A value that specifies whether the workgroup can be accessible from # a public network. # @return [Boolean] # # @!attribute [rw] security_group_ids # An array of security group IDs to associate with the workgroup. # @return [Array] # # @!attribute [rw] subnet_ids # An array of VPC subnet IDs to associate with the workgroup. # @return [Array] # # @!attribute [rw] workgroup_name # The name of the workgroup to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateWorkgroupRequest AWS API Documentation # class UpdateWorkgroupRequest < Struct.new( :base_capacity, :config_parameters, :enhanced_vpc_routing, :publicly_accessible, :security_group_ids, :subnet_ids, :workgroup_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] workgroup # The updated workgroup object. # @return [Types::Workgroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UpdateWorkgroupResponse AWS API Documentation # class UpdateWorkgroupResponse < Struct.new( :workgroup) SENSITIVE = [] include Aws::Structure end # The usage limit object. # # @!attribute [rw] amount # The limit amount. If time-based, this amount is in RPUs consumed per # hour. If data-based, this amount is in terabytes (TB). The value # must be a positive number. # @return [Integer] # # @!attribute [rw] breach_action # The action that Amazon Redshift Serverless takes when the limit is # reached. # @return [String] # # @!attribute [rw] period # The time period that the amount applies to. A weekly period begins # on Sunday. The default is monthly. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) that identifies the Amazon Redshift # Serverless resource. # @return [String] # # @!attribute [rw] usage_limit_arn # The Amazon Resource Name (ARN) of the resource associated with the # usage limit. # @return [String] # # @!attribute [rw] usage_limit_id # The identifier of the usage limit. # @return [String] # # @!attribute [rw] usage_type # The Amazon Redshift Serverless feature to limit. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/UsageLimit AWS API Documentation # class UsageLimit < Struct.new( :amount, :breach_action, :period, :resource_arn, :usage_limit_arn, :usage_limit_id, :usage_type) SENSITIVE = [] include Aws::Structure end # The input failed to satisfy the constraints specified by an AWS # service. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ValidationException AWS API Documentation # class ValidationException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The connection endpoint for connecting to Amazon Redshift Serverless # through the proxy. # # @!attribute [rw] network_interfaces # One or more network interfaces of the endpoint. Also known as an # interface endpoint. # @return [Array] # # @!attribute [rw] vpc_endpoint_id # The connection endpoint ID for connecting to Amazon Redshift # Serverless. # @return [String] # # @!attribute [rw] vpc_id # The VPC identifier that the endpoint is associated with. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/VpcEndpoint AWS API Documentation # class VpcEndpoint < Struct.new( :network_interfaces, :vpc_endpoint_id, :vpc_id) SENSITIVE = [] include Aws::Structure end # Describes the members of a VPC security group. # # @!attribute [rw] status # The status of the VPC security group. # @return [String] # # @!attribute [rw] vpc_security_group_id # The unique identifier of the VPC security group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/VpcSecurityGroupMembership AWS API Documentation # class VpcSecurityGroupMembership < Struct.new( :status, :vpc_security_group_id) SENSITIVE = [] include Aws::Structure end # The collection of computing resources from which an endpoint is # created. # # @!attribute [rw] base_capacity # The base data warehouse capacity of the workgroup in Redshift # Processing Units (RPUs). # @return [Integer] # # @!attribute [rw] config_parameters # An array of parameters to set for finer control over a database. The # options are `datestyle`, `enable_user_activity_logging`, # `query_group`, `search_path`, and `max_query_execution_time`. # @return [Array] # # @!attribute [rw] creation_date # The creation date of the workgroup. # @return [Time] # # @!attribute [rw] endpoint # The endpoint that is created from the workgroup. # @return [Types::Endpoint] # # @!attribute [rw] enhanced_vpc_routing # The value that specifies whether to enable enhanced virtual private # cloud (VPC) routing, which forces Amazon Redshift Serverless to # route traffic through your VPC. # @return [Boolean] # # @!attribute [rw] namespace_name # The namespace the workgroup is associated with. # @return [String] # # @!attribute [rw] publicly_accessible # A value that specifies whether the workgroup can be accessible from # a public network # @return [Boolean] # # @!attribute [rw] security_group_ids # An array of security group IDs to associate with the workgroup. # @return [Array] # # @!attribute [rw] status # The status of the workgroup. # @return [String] # # @!attribute [rw] subnet_ids # An array of subnet IDs the workgroup is associated with. # @return [Array] # # @!attribute [rw] workgroup_arn # The Amazon Resource Name (ARN) that links to the workgroup. # @return [String] # # @!attribute [rw] workgroup_id # The unique identifier of the workgroup. # @return [String] # # @!attribute [rw] workgroup_name # The name of the workgroup. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/Workgroup AWS API Documentation # class Workgroup < Struct.new( :base_capacity, :config_parameters, :creation_date, :endpoint, :enhanced_vpc_routing, :namespace_name, :publicly_accessible, :security_group_ids, :status, :subnet_ids, :workgroup_arn, :workgroup_id, :workgroup_name) SENSITIVE = [] include Aws::Structure end end end