| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.RedshiftServerLess
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ConvertRecoveryPointToSnapshot
- CreateEndpointAccess
- CreateNamespace
- CreateSnapshot
- CreateUsageLimit
- CreateWorkgroup
- DeleteEndpointAccess
- DeleteNamespace
- DeleteResourcePolicy
- DeleteSnapshot
- DeleteUsageLimit
- DeleteWorkgroup
- GetCredentials
- GetEndpointAccess
- GetNamespace
- GetRecoveryPoint
- GetResourcePolicy
- GetSnapshot
- GetTableRestoreStatus
- GetUsageLimit
- GetWorkgroup
- ListEndpointAccess (Paginated)
- ListNamespaces (Paginated)
- ListRecoveryPoints (Paginated)
- ListSnapshots (Paginated)
- ListTableRestoreStatus (Paginated)
- ListTagsForResource
- ListUsageLimits (Paginated)
- ListWorkgroups (Paginated)
- PutResourcePolicy
- RestoreFromRecoveryPoint
- RestoreFromSnapshot
- RestoreTableFromSnapshot
- TagResource
- UntagResource
- UpdateEndpointAccess
- UpdateNamespace
- UpdateSnapshot
- UpdateUsageLimit
- UpdateWorkgroup
- Types
Description
Derived from API version 2021-04-21 of the AWS service descriptions, licensed under Apache 2.0.
This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.
Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.
To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InsufficientCapacityException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidPaginationException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data ConvertRecoveryPointToSnapshot = ConvertRecoveryPointToSnapshot' (Maybe Int) (Maybe [Tag]) Text Text
- newConvertRecoveryPointToSnapshot :: Text -> Text -> ConvertRecoveryPointToSnapshot
- data ConvertRecoveryPointToSnapshotResponse = ConvertRecoveryPointToSnapshotResponse' (Maybe Snapshot) Int
- newConvertRecoveryPointToSnapshotResponse :: Int -> ConvertRecoveryPointToSnapshotResponse
- data CreateEndpointAccess = CreateEndpointAccess' (Maybe [Text]) Text [Text] Text
- newCreateEndpointAccess :: Text -> Text -> CreateEndpointAccess
- data CreateEndpointAccessResponse = CreateEndpointAccessResponse' (Maybe EndpointAccess) Int
- newCreateEndpointAccessResponse :: Int -> CreateEndpointAccessResponse
- data CreateNamespace = CreateNamespace' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [LogExport]) (Maybe [Tag]) Text
- newCreateNamespace :: Text -> CreateNamespace
- data CreateNamespaceResponse = CreateNamespaceResponse' (Maybe Namespace) Int
- newCreateNamespaceResponse :: Int -> CreateNamespaceResponse
- data CreateSnapshot = CreateSnapshot' (Maybe Int) (Maybe [Tag]) Text Text
- newCreateSnapshot :: Text -> Text -> CreateSnapshot
- data CreateSnapshotResponse = CreateSnapshotResponse' (Maybe Snapshot) Int
- newCreateSnapshotResponse :: Int -> CreateSnapshotResponse
- data CreateUsageLimit = CreateUsageLimit' (Maybe UsageLimitBreachAction) (Maybe UsageLimitPeriod) Integer Text UsageLimitUsageType
- newCreateUsageLimit :: Integer -> Text -> UsageLimitUsageType -> CreateUsageLimit
- data CreateUsageLimitResponse = CreateUsageLimitResponse' (Maybe UsageLimit) Int
- newCreateUsageLimitResponse :: Int -> CreateUsageLimitResponse
- data CreateWorkgroup = CreateWorkgroup' (Maybe Int) (Maybe [ConfigParameter]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text
- newCreateWorkgroup :: Text -> Text -> CreateWorkgroup
- data CreateWorkgroupResponse = CreateWorkgroupResponse' (Maybe Workgroup) Int
- newCreateWorkgroupResponse :: Int -> CreateWorkgroupResponse
- data DeleteEndpointAccess = DeleteEndpointAccess' Text
- newDeleteEndpointAccess :: Text -> DeleteEndpointAccess
- data DeleteEndpointAccessResponse = DeleteEndpointAccessResponse' (Maybe EndpointAccess) Int
- newDeleteEndpointAccessResponse :: Int -> DeleteEndpointAccessResponse
- data DeleteNamespace = DeleteNamespace' (Maybe Text) (Maybe Int) Text
- newDeleteNamespace :: Text -> DeleteNamespace
- data DeleteNamespaceResponse = DeleteNamespaceResponse' Int Namespace
- newDeleteNamespaceResponse :: Int -> Namespace -> DeleteNamespaceResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' Text
- newDeleteResourcePolicy :: Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data DeleteSnapshot = DeleteSnapshot' Text
- newDeleteSnapshot :: Text -> DeleteSnapshot
- data DeleteSnapshotResponse = DeleteSnapshotResponse' (Maybe Snapshot) Int
- newDeleteSnapshotResponse :: Int -> DeleteSnapshotResponse
- data DeleteUsageLimit = DeleteUsageLimit' Text
- newDeleteUsageLimit :: Text -> DeleteUsageLimit
- data DeleteUsageLimitResponse = DeleteUsageLimitResponse' (Maybe UsageLimit) Int
- newDeleteUsageLimitResponse :: Int -> DeleteUsageLimitResponse
- data DeleteWorkgroup = DeleteWorkgroup' Text
- newDeleteWorkgroup :: Text -> DeleteWorkgroup
- data DeleteWorkgroupResponse = DeleteWorkgroupResponse' Int Workgroup
- newDeleteWorkgroupResponse :: Int -> Workgroup -> DeleteWorkgroupResponse
- data GetCredentials = GetCredentials' (Maybe Text) (Maybe Int) Text
- newGetCredentials :: Text -> GetCredentials
- data GetCredentialsResponse = GetCredentialsResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) Int
- newGetCredentialsResponse :: Int -> GetCredentialsResponse
- data GetEndpointAccess = GetEndpointAccess' Text
- newGetEndpointAccess :: Text -> GetEndpointAccess
- data GetEndpointAccessResponse = GetEndpointAccessResponse' (Maybe EndpointAccess) Int
- newGetEndpointAccessResponse :: Int -> GetEndpointAccessResponse
- data GetNamespace = GetNamespace' Text
- newGetNamespace :: Text -> GetNamespace
- data GetNamespaceResponse = GetNamespaceResponse' Int Namespace
- newGetNamespaceResponse :: Int -> Namespace -> GetNamespaceResponse
- data GetRecoveryPoint = GetRecoveryPoint' Text
- newGetRecoveryPoint :: Text -> GetRecoveryPoint
- data GetRecoveryPointResponse = GetRecoveryPointResponse' (Maybe RecoveryPoint) Int
- newGetRecoveryPointResponse :: Int -> GetRecoveryPointResponse
- data GetResourcePolicy = GetResourcePolicy' Text
- newGetResourcePolicy :: Text -> GetResourcePolicy
- data GetResourcePolicyResponse = GetResourcePolicyResponse' (Maybe ResourcePolicy) Int
- newGetResourcePolicyResponse :: Int -> GetResourcePolicyResponse
- data GetSnapshot = GetSnapshot' (Maybe Text) (Maybe Text) (Maybe Text)
- newGetSnapshot :: GetSnapshot
- data GetSnapshotResponse = GetSnapshotResponse' (Maybe Snapshot) Int
- newGetSnapshotResponse :: Int -> GetSnapshotResponse
- data GetTableRestoreStatus = GetTableRestoreStatus' Text
- newGetTableRestoreStatus :: Text -> GetTableRestoreStatus
- data GetTableRestoreStatusResponse = GetTableRestoreStatusResponse' (Maybe TableRestoreStatus) Int
- newGetTableRestoreStatusResponse :: Int -> GetTableRestoreStatusResponse
- data GetUsageLimit = GetUsageLimit' Text
- newGetUsageLimit :: Text -> GetUsageLimit
- data GetUsageLimitResponse = GetUsageLimitResponse' (Maybe UsageLimit) Int
- newGetUsageLimitResponse :: Int -> GetUsageLimitResponse
- data GetWorkgroup = GetWorkgroup' Text
- newGetWorkgroup :: Text -> GetWorkgroup
- data GetWorkgroupResponse = GetWorkgroupResponse' Int Workgroup
- newGetWorkgroupResponse :: Int -> Workgroup -> GetWorkgroupResponse
- data ListEndpointAccess = ListEndpointAccess' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newListEndpointAccess :: ListEndpointAccess
- data ListEndpointAccessResponse = ListEndpointAccessResponse' (Maybe Text) Int [EndpointAccess]
- newListEndpointAccessResponse :: Int -> ListEndpointAccessResponse
- data ListNamespaces = ListNamespaces' (Maybe Natural) (Maybe Text)
- newListNamespaces :: ListNamespaces
- data ListNamespacesResponse = ListNamespacesResponse' (Maybe Text) Int [Namespace]
- newListNamespacesResponse :: Int -> ListNamespacesResponse
- data ListRecoveryPoints = ListRecoveryPoints' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newListRecoveryPoints :: ListRecoveryPoints
- data ListRecoveryPointsResponse = ListRecoveryPointsResponse' (Maybe Text) (Maybe [RecoveryPoint]) Int
- newListRecoveryPointsResponse :: Int -> ListRecoveryPointsResponse
- data ListSnapshots = ListSnapshots' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newListSnapshots :: ListSnapshots
- data ListSnapshotsResponse = ListSnapshotsResponse' (Maybe Text) (Maybe [Snapshot]) Int
- newListSnapshotsResponse :: Int -> ListSnapshotsResponse
- data ListTableRestoreStatus = ListTableRestoreStatus' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newListTableRestoreStatus :: ListTableRestoreStatus
- data ListTableRestoreStatusResponse = ListTableRestoreStatusResponse' (Maybe Text) (Maybe [TableRestoreStatus]) Int
- newListTableRestoreStatusResponse :: Int -> ListTableRestoreStatusResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListUsageLimits = ListUsageLimits' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe UsageLimitUsageType)
- newListUsageLimits :: ListUsageLimits
- data ListUsageLimitsResponse = ListUsageLimitsResponse' (Maybe Text) (Maybe (NonEmpty UsageLimit)) Int
- newListUsageLimitsResponse :: Int -> ListUsageLimitsResponse
- data ListWorkgroups = ListWorkgroups' (Maybe Natural) (Maybe Text)
- newListWorkgroups :: ListWorkgroups
- data ListWorkgroupsResponse = ListWorkgroupsResponse' (Maybe Text) Int [Workgroup]
- newListWorkgroupsResponse :: Int -> ListWorkgroupsResponse
- data PutResourcePolicy = PutResourcePolicy' Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe ResourcePolicy) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data RestoreFromRecoveryPoint = RestoreFromRecoveryPoint' Text Text Text
- newRestoreFromRecoveryPoint :: Text -> Text -> Text -> RestoreFromRecoveryPoint
- data RestoreFromRecoveryPointResponse = RestoreFromRecoveryPointResponse' (Maybe Namespace) (Maybe Text) Int
- newRestoreFromRecoveryPointResponse :: Int -> RestoreFromRecoveryPointResponse
- data RestoreFromSnapshot = RestoreFromSnapshot' (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newRestoreFromSnapshot :: Text -> Text -> RestoreFromSnapshot
- data RestoreFromSnapshotResponse = RestoreFromSnapshotResponse' (Maybe Namespace) (Maybe Text) (Maybe Text) Int
- newRestoreFromSnapshotResponse :: Int -> RestoreFromSnapshotResponse
- data RestoreTableFromSnapshot = RestoreTableFromSnapshot' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text Text Text Text
- newRestoreTableFromSnapshot :: Text -> Text -> Text -> Text -> Text -> Text -> RestoreTableFromSnapshot
- data RestoreTableFromSnapshotResponse = RestoreTableFromSnapshotResponse' (Maybe TableRestoreStatus) Int
- newRestoreTableFromSnapshotResponse :: Int -> RestoreTableFromSnapshotResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateEndpointAccess = UpdateEndpointAccess' (Maybe [Text]) Text
- newUpdateEndpointAccess :: Text -> UpdateEndpointAccess
- data UpdateEndpointAccessResponse = UpdateEndpointAccessResponse' (Maybe EndpointAccess) Int
- newUpdateEndpointAccessResponse :: Int -> UpdateEndpointAccessResponse
- data UpdateNamespace = UpdateNamespace' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [LogExport]) Text
- newUpdateNamespace :: Text -> UpdateNamespace
- data UpdateNamespaceResponse = UpdateNamespaceResponse' Int Namespace
- newUpdateNamespaceResponse :: Int -> Namespace -> UpdateNamespaceResponse
- data UpdateSnapshot = UpdateSnapshot' (Maybe Int) Text
- newUpdateSnapshot :: Text -> UpdateSnapshot
- data UpdateSnapshotResponse = UpdateSnapshotResponse' (Maybe Snapshot) Int
- newUpdateSnapshotResponse :: Int -> UpdateSnapshotResponse
- data UpdateUsageLimit = UpdateUsageLimit' (Maybe Integer) (Maybe UsageLimitBreachAction) Text
- newUpdateUsageLimit :: Text -> UpdateUsageLimit
- data UpdateUsageLimitResponse = UpdateUsageLimitResponse' (Maybe UsageLimit) Int
- newUpdateUsageLimitResponse :: Int -> UpdateUsageLimitResponse
- data UpdateWorkgroup = UpdateWorkgroup' (Maybe Int) (Maybe [ConfigParameter]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) Text
- newUpdateWorkgroup :: Text -> UpdateWorkgroup
- data UpdateWorkgroupResponse = UpdateWorkgroupResponse' Int Workgroup
- newUpdateWorkgroupResponse :: Int -> Workgroup -> UpdateWorkgroupResponse
- newtype LogExport where
- LogExport' { }
- pattern LogExport_Connectionlog :: LogExport
- pattern LogExport_Useractivitylog :: LogExport
- pattern LogExport_Userlog :: LogExport
- newtype NamespaceStatus where
- NamespaceStatus' { }
- pattern NamespaceStatus_AVAILABLE :: NamespaceStatus
- pattern NamespaceStatus_DELETING :: NamespaceStatus
- pattern NamespaceStatus_MODIFYING :: NamespaceStatus
- newtype SnapshotStatus where
- SnapshotStatus' { }
- pattern SnapshotStatus_AVAILABLE :: SnapshotStatus
- pattern SnapshotStatus_CANCELLED :: SnapshotStatus
- pattern SnapshotStatus_COPYING :: SnapshotStatus
- pattern SnapshotStatus_CREATING :: SnapshotStatus
- pattern SnapshotStatus_DELETED :: SnapshotStatus
- pattern SnapshotStatus_FAILED :: SnapshotStatus
- newtype UsageLimitBreachAction where
- newtype UsageLimitPeriod where
- UsageLimitPeriod' { }
- pattern UsageLimitPeriod_Daily :: UsageLimitPeriod
- pattern UsageLimitPeriod_Monthly :: UsageLimitPeriod
- pattern UsageLimitPeriod_Weekly :: UsageLimitPeriod
- newtype UsageLimitUsageType where
- newtype WorkgroupStatus where
- WorkgroupStatus' { }
- pattern WorkgroupStatus_AVAILABLE :: WorkgroupStatus
- pattern WorkgroupStatus_CREATING :: WorkgroupStatus
- pattern WorkgroupStatus_DELETING :: WorkgroupStatus
- pattern WorkgroupStatus_MODIFYING :: WorkgroupStatus
- data ConfigParameter = ConfigParameter' (Maybe Text) (Maybe Text)
- newConfigParameter :: ConfigParameter
- data Endpoint = Endpoint' (Maybe Text) (Maybe Int) (Maybe [VpcEndpoint])
- newEndpoint :: Endpoint
- data EndpointAccess = EndpointAccess' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe VpcEndpoint) (Maybe [VpcSecurityGroupMembership]) (Maybe Text)
- newEndpointAccess :: EndpointAccess
- data Namespace = Namespace' (Maybe (Sensitive Text)) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [LogExport]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NamespaceStatus)
- newNamespace :: Namespace
- data NetworkInterface = NetworkInterface' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newNetworkInterface :: NetworkInterface
- data RecoveryPoint = RecoveryPoint' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Double) (Maybe Text)
- newRecoveryPoint :: RecoveryPoint
- data ResourcePolicy = ResourcePolicy' (Maybe Text) (Maybe Text)
- newResourcePolicy :: ResourcePolicy
- data Snapshot = Snapshot' (Maybe [Text]) (Maybe [Text]) (Maybe Double) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe ISO8601) (Maybe SnapshotStatus) (Maybe Double)
- newSnapshot :: Snapshot
- data TableRestoreStatus = TableRestoreStatus' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text)
- newTableRestoreStatus :: TableRestoreStatus
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data UsageLimit = UsageLimit' (Maybe Integer) (Maybe UsageLimitBreachAction) (Maybe UsageLimitPeriod) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UsageLimitUsageType)
- newUsageLimit :: UsageLimit
- data VpcEndpoint = VpcEndpoint' (Maybe [NetworkInterface]) (Maybe Text) (Maybe Text)
- newVpcEndpoint :: VpcEndpoint
- data VpcSecurityGroupMembership = VpcSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
- data Workgroup = Workgroup' (Maybe Int) (Maybe [ConfigParameter]) (Maybe ISO8601) (Maybe Endpoint) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe [Text]) (Maybe WorkgroupStatus) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text)
- newWorkgroup :: Workgroup
Service Configuration
defaultService :: Service Source #
API version 2021-04-21 of the Amazon Redshift Serverless SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RedshiftServerLess.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The submitted action has conflicts.
InsufficientCapacityException
_InsufficientCapacityException :: AsError a => Fold a ServiceError Source #
There is an insufficient capacity to perform the action.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure.
InvalidPaginationException
_InvalidPaginationException :: AsError a => Fold a ServiceError Source #
The provided pagination token is invalid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource could not be found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The service limit was exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
The request exceeded the number of tags allowed for a resource.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input failed to satisfy the constraints specified by an AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ConvertRecoveryPointToSnapshot
data ConvertRecoveryPointToSnapshot Source #
See: newConvertRecoveryPointToSnapshot smart constructor.
Instances
newConvertRecoveryPointToSnapshot Source #
Arguments
| :: Text | |
| -> Text | |
| -> ConvertRecoveryPointToSnapshot |
Create a value of ConvertRecoveryPointToSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionPeriod:ConvertRecoveryPointToSnapshot', convertRecoveryPointToSnapshot_retentionPeriod - How long to retain the snapshot.
$sel:tags:ConvertRecoveryPointToSnapshot', convertRecoveryPointToSnapshot_tags - An array of
Tag objects
to associate with the created snapshot.
ConvertRecoveryPointToSnapshot, convertRecoveryPointToSnapshot_recoveryPointId - The unique identifier of the recovery point.
ConvertRecoveryPointToSnapshot, convertRecoveryPointToSnapshot_snapshotName - The name of the snapshot.
data ConvertRecoveryPointToSnapshotResponse Source #
See: newConvertRecoveryPointToSnapshotResponse smart constructor.
Constructors
| ConvertRecoveryPointToSnapshotResponse' (Maybe Snapshot) Int |
Instances
newConvertRecoveryPointToSnapshotResponse Source #
Arguments
| :: Int | |
| -> ConvertRecoveryPointToSnapshotResponse |
Create a value of ConvertRecoveryPointToSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:ConvertRecoveryPointToSnapshotResponse', convertRecoveryPointToSnapshotResponse_snapshot - The snapshot converted from the recovery point.
$sel:httpStatus:ConvertRecoveryPointToSnapshotResponse', convertRecoveryPointToSnapshotResponse_httpStatus - The response's http status code.
CreateEndpointAccess
data CreateEndpointAccess Source #
See: newCreateEndpointAccess smart constructor.
Instances
newCreateEndpointAccess Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateEndpointAccess |
Create a value of CreateEndpointAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpcSecurityGroupIds:CreateEndpointAccess', createEndpointAccess_vpcSecurityGroupIds - The unique identifiers of the security group that defines the ports,
protocols, and sources for inbound traffic that you are authorizing into
your endpoint.
CreateEndpointAccess, createEndpointAccess_endpointName - 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.
CreateEndpointAccess, createEndpointAccess_subnetIds - The unique identifers of subnets from which Amazon Redshift Serverless
chooses one to deploy a VPC endpoint.
CreateEndpointAccess, createEndpointAccess_workgroupName - The name of the workgroup to associate with the VPC endpoint.
data CreateEndpointAccessResponse Source #
See: newCreateEndpointAccessResponse smart constructor.
Constructors
| CreateEndpointAccessResponse' (Maybe EndpointAccess) Int |
Instances
newCreateEndpointAccessResponse Source #
Create a value of CreateEndpointAccessResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEndpointAccessResponse, createEndpointAccessResponse_endpoint - The created VPC endpoint.
$sel:httpStatus:CreateEndpointAccessResponse', createEndpointAccessResponse_httpStatus - The response's http status code.
CreateNamespace
data CreateNamespace Source #
See: newCreateNamespace smart constructor.
Constructors
| CreateNamespace' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [LogExport]) (Maybe [Tag]) Text |
Instances
Arguments
| :: Text | |
| -> CreateNamespace |
Create a value of CreateNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:adminUserPassword:CreateNamespace', createNamespace_adminUserPassword - The password of the administrator for the first database created in the
namespace.
CreateNamespace, createNamespace_adminUsername - The username of the administrator for the first database created in the
namespace.
CreateNamespace, createNamespace_dbName - The name of the first database created in the namespace.
CreateNamespace, createNamespace_defaultIamRoleArn - The Amazon Resource Name (ARN) of the IAM role to set as a default in
the namespace.
CreateNamespace, createNamespace_iamRoles - A list of IAM roles to associate with the namespace.
CreateNamespace, createNamespace_kmsKeyId - The ID of the Amazon Web Services Key Management Service key used to
encrypt your data.
CreateNamespace, createNamespace_logExports - The types of logs the namespace can export. Available export types are
userlog, connectionlog, and useractivitylog.
$sel:tags:CreateNamespace', createNamespace_tags - A list of tag instances.
CreateNamespace, createNamespace_namespaceName - The name of the namespace.
data CreateNamespaceResponse Source #
See: newCreateNamespaceResponse smart constructor.
Constructors
| CreateNamespaceResponse' (Maybe Namespace) Int |
Instances
newCreateNamespaceResponse Source #
Create a value of CreateNamespaceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:CreateNamespaceResponse', createNamespaceResponse_namespace - The created namespace object.
$sel:httpStatus:CreateNamespaceResponse', createNamespaceResponse_httpStatus - The response's http status code.
CreateSnapshot
data CreateSnapshot Source #
See: newCreateSnapshot smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSnapshot |
Create a value of CreateSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionPeriod:CreateSnapshot', createSnapshot_retentionPeriod - How long to retain the created snapshot.
$sel:tags:CreateSnapshot', createSnapshot_tags - An array of
Tag objects
to associate with the snapshot.
CreateSnapshot, createSnapshot_namespaceName - The namespace to create a snapshot for.
CreateSnapshot, createSnapshot_snapshotName - The name of the snapshot.
data CreateSnapshotResponse Source #
See: newCreateSnapshotResponse smart constructor.
Constructors
| CreateSnapshotResponse' (Maybe Snapshot) Int |
Instances
newCreateSnapshotResponse Source #
Create a value of CreateSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:CreateSnapshotResponse', createSnapshotResponse_snapshot - The created snapshot object.
$sel:httpStatus:CreateSnapshotResponse', createSnapshotResponse_httpStatus - The response's http status code.
CreateUsageLimit
data CreateUsageLimit Source #
See: newCreateUsageLimit smart constructor.
Constructors
| CreateUsageLimit' (Maybe UsageLimitBreachAction) (Maybe UsageLimitPeriod) Integer Text UsageLimitUsageType |
Instances
Arguments
| :: Integer | |
| -> Text | |
| -> UsageLimitUsageType | |
| -> CreateUsageLimit |
Create a value of CreateUsageLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUsageLimit, createUsageLimit_breachAction - The action that Amazon Redshift Serverless takes when the limit is
reached. The default is log.
CreateUsageLimit, createUsageLimit_period - The time period that the amount applies to. A weekly period begins on
Sunday. The default is monthly.
CreateUsageLimit, createUsageLimit_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.
CreateUsageLimit, createUsageLimit_resourceArn - The Amazon Resource Name (ARN) of the Amazon Redshift Serverless
resource to create the usage limit for.
CreateUsageLimit, createUsageLimit_usageType - The type of Amazon Redshift Serverless usage to create a usage limit
for.
data CreateUsageLimitResponse Source #
See: newCreateUsageLimitResponse smart constructor.
Constructors
| CreateUsageLimitResponse' (Maybe UsageLimit) Int |
Instances
newCreateUsageLimitResponse Source #
Create a value of CreateUsageLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:usageLimit:CreateUsageLimitResponse', createUsageLimitResponse_usageLimit - The returned usage limit object.
$sel:httpStatus:CreateUsageLimitResponse', createUsageLimitResponse_httpStatus - The response's http status code.
CreateWorkgroup
data CreateWorkgroup Source #
See: newCreateWorkgroup smart constructor.
Constructors
| CreateWorkgroup' (Maybe Int) (Maybe [ConfigParameter]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateWorkgroup |
Create a value of CreateWorkgroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorkgroup, createWorkgroup_baseCapacity - The base data warehouse capacity of the workgroup in Redshift Processing
Units (RPUs).
CreateWorkgroup, createWorkgroup_configParameters - 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.
CreateWorkgroup, createWorkgroup_enhancedVpcRouting - 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.
CreateWorkgroup, createWorkgroup_port - The custom port to use when connecting to a workgroup. Valid port ranges
are 5431-5455 and 8191-8215. The default is 5439.
CreateWorkgroup, createWorkgroup_publiclyAccessible - A value that specifies whether the workgroup can be accessed from a
public network.
CreateWorkgroup, createWorkgroup_securityGroupIds - An array of security group IDs to associate with the workgroup.
CreateWorkgroup, createWorkgroup_subnetIds - An array of VPC subnet IDs to associate with the workgroup.
$sel:tags:CreateWorkgroup', createWorkgroup_tags - A array of tag instances.
CreateWorkgroup, createWorkgroup_namespaceName - The name of the namespace to associate with the workgroup.
CreateWorkgroup, createWorkgroup_workgroupName - The name of the created workgroup.
data CreateWorkgroupResponse Source #
See: newCreateWorkgroupResponse smart constructor.
Constructors
| CreateWorkgroupResponse' (Maybe Workgroup) Int |
Instances
newCreateWorkgroupResponse Source #
Create a value of CreateWorkgroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workgroup:CreateWorkgroupResponse', createWorkgroupResponse_workgroup - The created workgroup object.
$sel:httpStatus:CreateWorkgroupResponse', createWorkgroupResponse_httpStatus - The response's http status code.
DeleteEndpointAccess
data DeleteEndpointAccess Source #
See: newDeleteEndpointAccess smart constructor.
Constructors
| DeleteEndpointAccess' Text |
Instances
newDeleteEndpointAccess Source #
Arguments
| :: Text | |
| -> DeleteEndpointAccess |
Create a value of DeleteEndpointAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEndpointAccess, deleteEndpointAccess_endpointName - The name of the VPC endpoint to delete.
data DeleteEndpointAccessResponse Source #
See: newDeleteEndpointAccessResponse smart constructor.
Constructors
| DeleteEndpointAccessResponse' (Maybe EndpointAccess) Int |
Instances
newDeleteEndpointAccessResponse Source #
Create a value of DeleteEndpointAccessResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEndpointAccessResponse, deleteEndpointAccessResponse_endpoint - The deleted VPC endpoint.
$sel:httpStatus:DeleteEndpointAccessResponse', deleteEndpointAccessResponse_httpStatus - The response's http status code.
DeleteNamespace
data DeleteNamespace Source #
See: newDeleteNamespace smart constructor.
Instances
Arguments
| :: Text | |
| -> DeleteNamespace |
Create a value of DeleteNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalSnapshotName:DeleteNamespace', deleteNamespace_finalSnapshotName - The name of the snapshot to be created before the namespace is deleted.
$sel:finalSnapshotRetentionPeriod:DeleteNamespace', deleteNamespace_finalSnapshotRetentionPeriod - How long to retain the final snapshot.
DeleteNamespace, deleteNamespace_namespaceName - The name of the namespace to delete.
data DeleteNamespaceResponse Source #
See: newDeleteNamespaceResponse smart constructor.
Constructors
| DeleteNamespaceResponse' Int Namespace |
Instances
newDeleteNamespaceResponse Source #
Arguments
| :: Int | |
| -> Namespace | |
| -> DeleteNamespaceResponse |
Create a value of DeleteNamespaceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteNamespaceResponse', deleteNamespaceResponse_httpStatus - The response's http status code.
$sel:namespace:DeleteNamespaceResponse', deleteNamespaceResponse_namespace - The deleted namespace object.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy smart constructor.
Constructors
| DeleteResourcePolicy' Text |
Instances
newDeleteResourcePolicy Source #
Arguments
| :: Text | |
| -> DeleteResourcePolicy |
Create a value of DeleteResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourcePolicy, deleteResourcePolicy_resourceArn - The Amazon Resource Name (ARN) of the policy to delete.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse smart constructor.
Constructors
| DeleteResourcePolicyResponse' Int |
Instances
newDeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteResourcePolicyResponse', deleteResourcePolicyResponse_httpStatus - The response's http status code.
DeleteSnapshot
data DeleteSnapshot Source #
See: newDeleteSnapshot smart constructor.
Constructors
| DeleteSnapshot' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSnapshot |
Create a value of DeleteSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSnapshot, deleteSnapshot_snapshotName - The name of the snapshot to be deleted.
data DeleteSnapshotResponse Source #
See: newDeleteSnapshotResponse smart constructor.
Constructors
| DeleteSnapshotResponse' (Maybe Snapshot) Int |
Instances
newDeleteSnapshotResponse Source #
Create a value of DeleteSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:DeleteSnapshotResponse', deleteSnapshotResponse_snapshot - The deleted snapshot object.
$sel:httpStatus:DeleteSnapshotResponse', deleteSnapshotResponse_httpStatus - The response's http status code.
DeleteUsageLimit
data DeleteUsageLimit Source #
See: newDeleteUsageLimit smart constructor.
Constructors
| DeleteUsageLimit' Text |
Instances
Arguments
| :: Text | |
| -> DeleteUsageLimit |
Create a value of DeleteUsageLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteUsageLimit, deleteUsageLimit_usageLimitId - The unique identifier of the usage limit to delete.
data DeleteUsageLimitResponse Source #
See: newDeleteUsageLimitResponse smart constructor.
Constructors
| DeleteUsageLimitResponse' (Maybe UsageLimit) Int |
Instances
newDeleteUsageLimitResponse Source #
Create a value of DeleteUsageLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:usageLimit:DeleteUsageLimitResponse', deleteUsageLimitResponse_usageLimit - The deleted usage limit object.
$sel:httpStatus:DeleteUsageLimitResponse', deleteUsageLimitResponse_httpStatus - The response's http status code.
DeleteWorkgroup
data DeleteWorkgroup Source #
See: newDeleteWorkgroup smart constructor.
Constructors
| DeleteWorkgroup' Text |
Instances
Arguments
| :: Text | |
| -> DeleteWorkgroup |
Create a value of DeleteWorkgroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorkgroup, deleteWorkgroup_workgroupName - The name of the workgroup to be deleted.
data DeleteWorkgroupResponse Source #
See: newDeleteWorkgroupResponse smart constructor.
Constructors
| DeleteWorkgroupResponse' Int Workgroup |
Instances
newDeleteWorkgroupResponse Source #
Arguments
| :: Int | |
| -> Workgroup | |
| -> DeleteWorkgroupResponse |
Create a value of DeleteWorkgroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWorkgroupResponse', deleteWorkgroupResponse_httpStatus - The response's http status code.
$sel:workgroup:DeleteWorkgroupResponse', deleteWorkgroupResponse_workgroup - The deleted workgroup object.
GetCredentials
data GetCredentials Source #
See: newGetCredentials smart constructor.
Instances
Arguments
| :: Text | |
| -> GetCredentials |
Create a value of GetCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCredentials, getCredentials_dbName - 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 uppercase or 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 in the Amazon Redshift Database Developer Guide
$sel:durationSeconds:GetCredentials', getCredentials_durationSeconds - The number of seconds until the returned temporary password expires. The
minimum is 900 seconds, and the maximum is 3600 seconds.
GetCredentials, getCredentials_workgroupName - The name of the workgroup associated with the database.
data GetCredentialsResponse Source #
See: newGetCredentialsResponse smart constructor.
Constructors
| GetCredentialsResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) Int |
Instances
newGetCredentialsResponse Source #
Create a value of GetCredentialsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbPassword:GetCredentialsResponse', getCredentialsResponse_dbPassword - A temporary password that authorizes the user name returned by DbUser
to log on to the database DbName.
$sel:dbUser:GetCredentialsResponse', getCredentialsResponse_dbUser - 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.
$sel:expiration:GetCredentialsResponse', getCredentialsResponse_expiration - The date and time the password in DbPassword expires.
$sel:nextRefreshTime:GetCredentialsResponse', getCredentialsResponse_nextRefreshTime - The date and time of when the DbUser and DbPassword authorization
refreshes.
$sel:httpStatus:GetCredentialsResponse', getCredentialsResponse_httpStatus - The response's http status code.
GetEndpointAccess
data GetEndpointAccess Source #
See: newGetEndpointAccess smart constructor.
Constructors
| GetEndpointAccess' Text |
Instances
Arguments
| :: Text | |
| -> GetEndpointAccess |
Create a value of GetEndpointAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEndpointAccess, getEndpointAccess_endpointName - The name of the VPC endpoint to return information for.
data GetEndpointAccessResponse Source #
See: newGetEndpointAccessResponse smart constructor.
Constructors
| GetEndpointAccessResponse' (Maybe EndpointAccess) Int |
Instances
newGetEndpointAccessResponse Source #
Create a value of GetEndpointAccessResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEndpointAccessResponse, getEndpointAccessResponse_endpoint - The returned VPC endpoint.
$sel:httpStatus:GetEndpointAccessResponse', getEndpointAccessResponse_httpStatus - The response's http status code.
GetNamespace
data GetNamespace Source #
See: newGetNamespace smart constructor.
Constructors
| GetNamespace' Text |
Instances
Arguments
| :: Text | |
| -> GetNamespace |
Create a value of GetNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetNamespace, getNamespace_namespaceName - The name of the namespace to retrieve information for.
data GetNamespaceResponse Source #
See: newGetNamespaceResponse smart constructor.
Constructors
| GetNamespaceResponse' Int Namespace |
Instances
newGetNamespaceResponse Source #
Arguments
| :: Int | |
| -> Namespace | |
| -> GetNamespaceResponse |
Create a value of GetNamespaceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetNamespaceResponse', getNamespaceResponse_httpStatus - The response's http status code.
$sel:namespace:GetNamespaceResponse', getNamespaceResponse_namespace - The returned namespace object.
GetRecoveryPoint
data GetRecoveryPoint Source #
See: newGetRecoveryPoint smart constructor.
Constructors
| GetRecoveryPoint' Text |
Instances
Arguments
| :: Text | |
| -> GetRecoveryPoint |
Create a value of GetRecoveryPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRecoveryPoint, getRecoveryPoint_recoveryPointId - The unique identifier of the recovery point to return information for.
data GetRecoveryPointResponse Source #
See: newGetRecoveryPointResponse smart constructor.
Constructors
| GetRecoveryPointResponse' (Maybe RecoveryPoint) Int |
Instances
newGetRecoveryPointResponse Source #
Create a value of GetRecoveryPointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recoveryPoint:GetRecoveryPointResponse', getRecoveryPointResponse_recoveryPoint - The returned recovery point object.
$sel:httpStatus:GetRecoveryPointResponse', getRecoveryPointResponse_httpStatus - The response's http status code.
GetResourcePolicy
data GetResourcePolicy Source #
See: newGetResourcePolicy smart constructor.
Constructors
| GetResourcePolicy' Text |
Instances
Arguments
| :: Text | |
| -> GetResourcePolicy |
Create a value of GetResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourcePolicy, getResourcePolicy_resourceArn - The Amazon Resource Name (ARN) of the resource to return.
data GetResourcePolicyResponse Source #
See: newGetResourcePolicyResponse smart constructor.
Constructors
| GetResourcePolicyResponse' (Maybe ResourcePolicy) Int |
Instances
newGetResourcePolicyResponse Source #
Create a value of GetResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourcePolicy:GetResourcePolicyResponse', getResourcePolicyResponse_resourcePolicy - The returned resource policy.
$sel:httpStatus:GetResourcePolicyResponse', getResourcePolicyResponse_httpStatus - The response's http status code.
GetSnapshot
data GetSnapshot Source #
See: newGetSnapshot smart constructor.
Instances
newGetSnapshot :: GetSnapshot Source #
Create a value of GetSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSnapshot, getSnapshot_ownerAccount - The owner Amazon Web Services account of a snapshot shared with another
user.
GetSnapshot, getSnapshot_snapshotArn - The Amazon Resource Name (ARN) of the snapshot to return.
GetSnapshot, getSnapshot_snapshotName - The name of the snapshot to return.
data GetSnapshotResponse Source #
See: newGetSnapshotResponse smart constructor.
Constructors
| GetSnapshotResponse' (Maybe Snapshot) Int |
Instances
newGetSnapshotResponse Source #
Arguments
| :: Int | |
| -> GetSnapshotResponse |
Create a value of GetSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:GetSnapshotResponse', getSnapshotResponse_snapshot - The returned snapshot object.
$sel:httpStatus:GetSnapshotResponse', getSnapshotResponse_httpStatus - The response's http status code.
GetTableRestoreStatus
data GetTableRestoreStatus Source #
See: newGetTableRestoreStatus smart constructor.
Constructors
| GetTableRestoreStatus' Text |
Instances
newGetTableRestoreStatus Source #
Arguments
| :: Text | |
| -> GetTableRestoreStatus |
Create a value of GetTableRestoreStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTableRestoreStatus, getTableRestoreStatus_tableRestoreRequestId - The ID of the RestoreTableFromSnapshot request to return status for.
data GetTableRestoreStatusResponse Source #
See: newGetTableRestoreStatusResponse smart constructor.
Constructors
| GetTableRestoreStatusResponse' (Maybe TableRestoreStatus) Int |
Instances
newGetTableRestoreStatusResponse Source #
Create a value of GetTableRestoreStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableRestoreStatus:GetTableRestoreStatusResponse', getTableRestoreStatusResponse_tableRestoreStatus - The returned TableRestoreStatus object that contains information about
the status of your RestoreTableFromSnapshot request.
$sel:httpStatus:GetTableRestoreStatusResponse', getTableRestoreStatusResponse_httpStatus - The response's http status code.
GetUsageLimit
data GetUsageLimit Source #
See: newGetUsageLimit smart constructor.
Constructors
| GetUsageLimit' Text |
Instances
Arguments
| :: Text | |
| -> GetUsageLimit |
Create a value of GetUsageLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetUsageLimit, getUsageLimit_usageLimitId - The unique identifier of the usage limit to return information for.
data GetUsageLimitResponse Source #
See: newGetUsageLimitResponse smart constructor.
Constructors
| GetUsageLimitResponse' (Maybe UsageLimit) Int |
Instances
newGetUsageLimitResponse Source #
Create a value of GetUsageLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:usageLimit:GetUsageLimitResponse', getUsageLimitResponse_usageLimit - The returned usage limit object.
$sel:httpStatus:GetUsageLimitResponse', getUsageLimitResponse_httpStatus - The response's http status code.
GetWorkgroup
data GetWorkgroup Source #
See: newGetWorkgroup smart constructor.
Constructors
| GetWorkgroup' Text |
Instances
Arguments
| :: Text | |
| -> GetWorkgroup |
Create a value of GetWorkgroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorkgroup, getWorkgroup_workgroupName - The name of the workgroup to return information for.
data GetWorkgroupResponse Source #
See: newGetWorkgroupResponse smart constructor.
Constructors
| GetWorkgroupResponse' Int Workgroup |
Instances
newGetWorkgroupResponse Source #
Arguments
| :: Int | |
| -> Workgroup | |
| -> GetWorkgroupResponse |
Create a value of GetWorkgroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetWorkgroupResponse', getWorkgroupResponse_httpStatus - The response's http status code.
$sel:workgroup:GetWorkgroupResponse', getWorkgroupResponse_workgroup - The returned workgroup object.
ListEndpointAccess (Paginated)
data ListEndpointAccess Source #
See: newListEndpointAccess smart constructor.
Instances
newListEndpointAccess :: ListEndpointAccess Source #
Create a value of ListEndpointAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEndpointAccess', listEndpointAccess_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListEndpointAccess, listEndpointAccess_nextToken - If your initial ListEndpointAccess operation returns a nextToken,
you can include the returned nextToken in following
ListEndpointAccess operations, which returns results in the next page.
ListEndpointAccess, listEndpointAccess_vpcId - The unique identifier of the virtual private cloud with access to Amazon
Redshift Serverless.
ListEndpointAccess, listEndpointAccess_workgroupName - The name of the workgroup associated with the VPC endpoint to return.
data ListEndpointAccessResponse Source #
See: newListEndpointAccessResponse smart constructor.
Constructors
| ListEndpointAccessResponse' (Maybe Text) Int [EndpointAccess] |
Instances
newListEndpointAccessResponse Source #
Create a value of ListEndpointAccessResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListEndpointAccess, listEndpointAccessResponse_nextToken - 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.
$sel:httpStatus:ListEndpointAccessResponse', listEndpointAccessResponse_httpStatus - The response's http status code.
$sel:endpoints:ListEndpointAccessResponse', listEndpointAccessResponse_endpoints - The returned VPC endpoints.
ListNamespaces (Paginated)
data ListNamespaces Source #
See: newListNamespaces smart constructor.
Constructors
| ListNamespaces' (Maybe Natural) (Maybe Text) |
Instances
newListNamespaces :: ListNamespaces Source #
Create a value of ListNamespaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListNamespaces', listNamespaces_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListNamespaces, listNamespaces_nextToken - If your initial ListNamespaces operation returns a nextToken, you
can include the returned nextToken in following ListNamespaces
operations, which returns results in the next page.
data ListNamespacesResponse Source #
See: newListNamespacesResponse smart constructor.
Constructors
| ListNamespacesResponse' (Maybe Text) Int [Namespace] |
Instances
newListNamespacesResponse Source #
Create a value of ListNamespacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListNamespaces, listNamespacesResponse_nextToken - 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.
$sel:httpStatus:ListNamespacesResponse', listNamespacesResponse_httpStatus - The response's http status code.
$sel:namespaces:ListNamespacesResponse', listNamespacesResponse_namespaces - The list of returned namespaces.
ListRecoveryPoints (Paginated)
data ListRecoveryPoints Source #
See: newListRecoveryPoints smart constructor.
Constructors
| ListRecoveryPoints' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newListRecoveryPoints :: ListRecoveryPoints Source #
Create a value of ListRecoveryPoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:ListRecoveryPoints', listRecoveryPoints_endTime - The time when creation of the recovery point finished.
$sel:maxResults:ListRecoveryPoints', listRecoveryPoints_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListRecoveryPoints, listRecoveryPoints_namespaceArn - The Amazon Resource Name (ARN) of the namespace from which to list
recovery points.
ListRecoveryPoints, listRecoveryPoints_namespaceName - The name of the namespace to list recovery points for.
ListRecoveryPoints, listRecoveryPoints_nextToken - If your initial ListRecoveryPoints operation returns a nextToken,
you can include the returned nextToken in following
ListRecoveryPoints operations, which returns results in the next page.
$sel:startTime:ListRecoveryPoints', listRecoveryPoints_startTime - The time when the recovery point's creation was initiated.
data ListRecoveryPointsResponse Source #
See: newListRecoveryPointsResponse smart constructor.
Constructors
| ListRecoveryPointsResponse' (Maybe Text) (Maybe [RecoveryPoint]) Int |
Instances
newListRecoveryPointsResponse Source #
Create a value of ListRecoveryPointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRecoveryPoints, listRecoveryPointsResponse_nextToken - 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.
$sel:recoveryPoints:ListRecoveryPointsResponse', listRecoveryPointsResponse_recoveryPoints - The returned recovery point objects.
$sel:httpStatus:ListRecoveryPointsResponse', listRecoveryPointsResponse_httpStatus - The response's http status code.
ListSnapshots (Paginated)
data ListSnapshots Source #
See: newListSnapshots smart constructor.
Constructors
| ListSnapshots' (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newListSnapshots :: ListSnapshots Source #
Create a value of ListSnapshots with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:ListSnapshots', listSnapshots_endTime - The timestamp showing when the snapshot creation finished.
$sel:maxResults:ListSnapshots', listSnapshots_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListSnapshots, listSnapshots_namespaceArn - The Amazon Resource Name (ARN) of the namespace from which to list all
snapshots.
ListSnapshots, listSnapshots_namespaceName - The namespace from which to list all snapshots.
ListSnapshots, listSnapshots_nextToken - 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.
ListSnapshots, listSnapshots_ownerAccount - The owner Amazon Web Services account of the snapshot.
$sel:startTime:ListSnapshots', listSnapshots_startTime - The time when the creation of the snapshot was initiated.
data ListSnapshotsResponse Source #
See: newListSnapshotsResponse smart constructor.
Instances
newListSnapshotsResponse Source #
Create a value of ListSnapshotsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSnapshots, listSnapshotsResponse_nextToken - 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.
$sel:snapshots:ListSnapshotsResponse', listSnapshotsResponse_snapshots - All of the returned snapshot objects.
$sel:httpStatus:ListSnapshotsResponse', listSnapshotsResponse_httpStatus - The response's http status code.
ListTableRestoreStatus (Paginated)
data ListTableRestoreStatus Source #
See: newListTableRestoreStatus smart constructor.
Instances
newListTableRestoreStatus :: ListTableRestoreStatus Source #
Create a value of ListTableRestoreStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTableRestoreStatus', listTableRestoreStatus_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListTableRestoreStatus, listTableRestoreStatus_namespaceName - The namespace from which to list all of the statuses of
RestoreTableFromSnapshot operations .
ListTableRestoreStatus, listTableRestoreStatus_nextToken - If your initial ListTableRestoreStatus operation returns a nextToken,
you can include the returned nextToken in following
ListTableRestoreStatus operations. This will return results on the
next page.
ListTableRestoreStatus, listTableRestoreStatus_workgroupName - The workgroup from which to list all of the statuses of
RestoreTableFromSnapshot operations.
data ListTableRestoreStatusResponse Source #
See: newListTableRestoreStatusResponse smart constructor.
Constructors
| ListTableRestoreStatusResponse' (Maybe Text) (Maybe [TableRestoreStatus]) Int |
Instances
newListTableRestoreStatusResponse Source #
Create a value of ListTableRestoreStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTableRestoreStatus, listTableRestoreStatusResponse_nextToken - If your initial ListTableRestoreStatus operation returns a
nextToken, you can include the returned nextToken in following
ListTableRestoreStatus operations. This will returns results on the
next page.
$sel:tableRestoreStatuses:ListTableRestoreStatusResponse', listTableRestoreStatusResponse_tableRestoreStatuses - The array of returned TableRestoreStatus objects.
$sel:httpStatus:ListTableRestoreStatusResponse', listTableRestoreStatusResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource to list tags for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A map of the key-value pairs assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListUsageLimits (Paginated)
data ListUsageLimits Source #
See: newListUsageLimits smart constructor.
Constructors
| ListUsageLimits' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe UsageLimitUsageType) |
Instances
newListUsageLimits :: ListUsageLimits Source #
Create a value of ListUsageLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListUsageLimits', listUsageLimits_maxResults - 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.
ListUsageLimits, listUsageLimits_nextToken - If your initial ListUsageLimits operation returns a nextToken, you
can include the returned nextToken in following ListUsageLimits
operations, which returns results in the next page.
ListUsageLimits, listUsageLimits_resourceArn - The Amazon Resource Name (ARN) associated with the resource whose usage
limits you want to list.
ListUsageLimits, listUsageLimits_usageType - The Amazon Redshift Serverless feature whose limits you want to see.
data ListUsageLimitsResponse Source #
See: newListUsageLimitsResponse smart constructor.
Constructors
| ListUsageLimitsResponse' (Maybe Text) (Maybe (NonEmpty UsageLimit)) Int |
Instances
newListUsageLimitsResponse Source #
Create a value of ListUsageLimitsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsageLimits, listUsageLimitsResponse_nextToken - 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.
$sel:usageLimits:ListUsageLimitsResponse', listUsageLimitsResponse_usageLimits - An array of returned usage limit objects.
$sel:httpStatus:ListUsageLimitsResponse', listUsageLimitsResponse_httpStatus - The response's http status code.
ListWorkgroups (Paginated)
data ListWorkgroups Source #
See: newListWorkgroups smart constructor.
Constructors
| ListWorkgroups' (Maybe Natural) (Maybe Text) |
Instances
newListWorkgroups :: ListWorkgroups Source #
Create a value of ListWorkgroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListWorkgroups', listWorkgroups_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
ListWorkgroups, listWorkgroups_nextToken - If your initial ListWorkgroups operation returns a nextToken, you can
include the returned nextToken in following ListNamespaces operations,
which returns results in the next page.
data ListWorkgroupsResponse Source #
See: newListWorkgroupsResponse smart constructor.
Constructors
| ListWorkgroupsResponse' (Maybe Text) Int [Workgroup] |
Instances
newListWorkgroupsResponse Source #
Create a value of ListWorkgroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkgroups, listWorkgroupsResponse_nextToken - 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.
$sel:httpStatus:ListWorkgroupsResponse', listWorkgroupsResponse_httpStatus - The response's http status code.
$sel:workgroups:ListWorkgroupsResponse', listWorkgroupsResponse_workgroups - The returned array of workgroups.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy smart constructor.
Constructors
| PutResourcePolicy' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PutResourcePolicy |
Create a value of PutResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutResourcePolicy, putResourcePolicy_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\" }]}"PutResourcePolicy, putResourcePolicy_resourceArn - The Amazon Resource Name (ARN) of the account to create or update a
resource policy for.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse smart constructor.
Constructors
| PutResourcePolicyResponse' (Maybe ResourcePolicy) Int |
Instances
newPutResourcePolicyResponse Source #
Create a value of PutResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourcePolicy:PutResourcePolicyResponse', putResourcePolicyResponse_resourcePolicy - The policy that was created or updated.
$sel:httpStatus:PutResourcePolicyResponse', putResourcePolicyResponse_httpStatus - The response's http status code.
RestoreFromRecoveryPoint
data RestoreFromRecoveryPoint Source #
See: newRestoreFromRecoveryPoint smart constructor.
Constructors
| RestoreFromRecoveryPoint' Text Text Text |
Instances
newRestoreFromRecoveryPoint Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> RestoreFromRecoveryPoint |
Create a value of RestoreFromRecoveryPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreFromRecoveryPoint, restoreFromRecoveryPoint_namespaceName - The name of the namespace to restore data into.
RestoreFromRecoveryPoint, restoreFromRecoveryPoint_recoveryPointId - The unique identifier of the recovery point to restore from.
RestoreFromRecoveryPoint, restoreFromRecoveryPoint_workgroupName - The name of the workgroup used to restore data.
data RestoreFromRecoveryPointResponse Source #
See: newRestoreFromRecoveryPointResponse smart constructor.
Instances
newRestoreFromRecoveryPointResponse Source #
Create a value of RestoreFromRecoveryPointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:RestoreFromRecoveryPointResponse', restoreFromRecoveryPointResponse_namespace - The namespace that data was restored into.
RestoreFromRecoveryPoint, restoreFromRecoveryPointResponse_recoveryPointId - The unique identifier of the recovery point used for the restore.
$sel:httpStatus:RestoreFromRecoveryPointResponse', restoreFromRecoveryPointResponse_httpStatus - The response's http status code.
RestoreFromSnapshot
data RestoreFromSnapshot Source #
See: newRestoreFromSnapshot smart constructor.
Instances
newRestoreFromSnapshot Source #
Arguments
| :: Text | |
| -> Text | |
| -> RestoreFromSnapshot |
Create a value of RestoreFromSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreFromSnapshot, restoreFromSnapshot_ownerAccount - The Amazon Web Services account that owns the snapshot.
RestoreFromSnapshot, restoreFromSnapshot_snapshotArn - The Amazon Resource Name (ARN) of the snapshot to restore from. Required
if restoring from Amazon Redshift Serverless to a provisioned cluster.
Must not be specified at the same time as snapshotName.
The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
RestoreFromSnapshot, restoreFromSnapshot_snapshotName - The name of the snapshot to restore from. Must not be specified at the
same time as snapshotArn.
RestoreFromSnapshot, restoreFromSnapshot_namespaceName - The name of the namespace to restore the snapshot to.
RestoreFromSnapshot, restoreFromSnapshot_workgroupName - The name of the workgroup used to restore the snapshot.
data RestoreFromSnapshotResponse Source #
See: newRestoreFromSnapshotResponse smart constructor.
Instances
newRestoreFromSnapshotResponse Source #
Create a value of RestoreFromSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:RestoreFromSnapshotResponse', restoreFromSnapshotResponse_namespace - Undocumented member.
RestoreFromSnapshot, restoreFromSnapshotResponse_ownerAccount - The owner Amazon Web Services; account of the snapshot that was
restored.
RestoreFromSnapshot, restoreFromSnapshotResponse_snapshotName - The name of the snapshot used to restore the namespace.
$sel:httpStatus:RestoreFromSnapshotResponse', restoreFromSnapshotResponse_httpStatus - The response's http status code.
RestoreTableFromSnapshot
data RestoreTableFromSnapshot Source #
See: newRestoreTableFromSnapshot smart constructor.
Constructors
| RestoreTableFromSnapshot' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text Text Text Text |
Instances
newRestoreTableFromSnapshot Source #
Create a value of RestoreTableFromSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activateCaseSensitiveIdentifier:RestoreTableFromSnapshot', restoreTableFromSnapshot_activateCaseSensitiveIdentifier - Indicates whether name identifiers for database, schema, and table are
case sensitive. If true, the names are case sensitive. If false, the
names are not case sensitive. The default is false.
RestoreTableFromSnapshot, restoreTableFromSnapshot_sourceSchemaName - The name of the source schema that contains the table being restored.
RestoreTableFromSnapshot, restoreTableFromSnapshot_targetDatabaseName - The name of the database to restore the table to.
RestoreTableFromSnapshot, restoreTableFromSnapshot_targetSchemaName - The name of the schema to restore the table to.
RestoreTableFromSnapshot, restoreTableFromSnapshot_namespaceName - The namespace of the snapshot to restore from.
RestoreTableFromSnapshot, restoreTableFromSnapshot_newTableName - The name of the table to create from the restore operation.
RestoreTableFromSnapshot, restoreTableFromSnapshot_snapshotName - The name of the snapshot to restore the table from.
RestoreTableFromSnapshot, restoreTableFromSnapshot_sourceDatabaseName - The name of the source database that contains the table being restored.
RestoreTableFromSnapshot, restoreTableFromSnapshot_sourceTableName - The name of the source table being restored.
RestoreTableFromSnapshot, restoreTableFromSnapshot_workgroupName - The workgroup to restore the table to.
data RestoreTableFromSnapshotResponse Source #
See: newRestoreTableFromSnapshotResponse smart constructor.
Constructors
| RestoreTableFromSnapshotResponse' (Maybe TableRestoreStatus) Int |
Instances
newRestoreTableFromSnapshotResponse Source #
Create a value of RestoreTableFromSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableRestoreStatus:RestoreTableFromSnapshotResponse', restoreTableFromSnapshotResponse_tableRestoreStatus - The TableRestoreStatus object that contains the status of the restore
operation.
$sel:httpStatus:RestoreTableFromSnapshotResponse', restoreTableFromSnapshotResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource, tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource to tag.
$sel:tags:TagResource', tagResource_tags - The map of the key-value pairs used to tag the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource, untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource to remove tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag or set of tags to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateEndpointAccess
data UpdateEndpointAccess Source #
See: newUpdateEndpointAccess smart constructor.
Constructors
| UpdateEndpointAccess' (Maybe [Text]) Text |
Instances
newUpdateEndpointAccess Source #
Arguments
| :: Text | |
| -> UpdateEndpointAccess |
Create a value of UpdateEndpointAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpcSecurityGroupIds:UpdateEndpointAccess', updateEndpointAccess_vpcSecurityGroupIds - The list of VPC security groups associated with the endpoint after the
endpoint is modified.
UpdateEndpointAccess, updateEndpointAccess_endpointName - The name of the VPC endpoint to update.
data UpdateEndpointAccessResponse Source #
See: newUpdateEndpointAccessResponse smart constructor.
Constructors
| UpdateEndpointAccessResponse' (Maybe EndpointAccess) Int |
Instances
newUpdateEndpointAccessResponse Source #
Create a value of UpdateEndpointAccessResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEndpointAccessResponse, updateEndpointAccessResponse_endpoint - The updated VPC endpoint.
$sel:httpStatus:UpdateEndpointAccessResponse', updateEndpointAccessResponse_httpStatus - The response's http status code.
UpdateNamespace
data UpdateNamespace Source #
See: newUpdateNamespace smart constructor.
Constructors
| UpdateNamespace' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [LogExport]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateNamespace |
Create a value of UpdateNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:adminUserPassword:UpdateNamespace', updateNamespace_adminUserPassword - The password of the administrator for the first database created in the
namespace.
UpdateNamespace, updateNamespace_adminUsername - The username of the administrator for the first database created in the
namespace.
UpdateNamespace, updateNamespace_defaultIamRoleArn - The Amazon Resource Name (ARN) of the IAM role to set as a default in
the namespace.
UpdateNamespace, updateNamespace_iamRoles - A list of IAM roles to associate with the namespace.
UpdateNamespace, updateNamespace_kmsKeyId - The ID of the Amazon Web Services Key Management Service key used to
encrypt your data.
UpdateNamespace, updateNamespace_logExports - The types of logs the namespace can export. The export types are
userlog, connectionlog, and useractivitylog.
UpdateNamespace, updateNamespace_namespaceName - The name of the namespace.
data UpdateNamespaceResponse Source #
See: newUpdateNamespaceResponse smart constructor.
Constructors
| UpdateNamespaceResponse' Int Namespace |
Instances
newUpdateNamespaceResponse Source #
Arguments
| :: Int | |
| -> Namespace | |
| -> UpdateNamespaceResponse |
Create a value of UpdateNamespaceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateNamespaceResponse', updateNamespaceResponse_httpStatus - The response's http status code.
$sel:namespace:UpdateNamespaceResponse', updateNamespaceResponse_namespace - A list of tag instances.
UpdateSnapshot
data UpdateSnapshot Source #
See: newUpdateSnapshot smart constructor.
Constructors
| UpdateSnapshot' (Maybe Int) Text |
Instances
Arguments
| :: Text | |
| -> UpdateSnapshot |
Create a value of UpdateSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionPeriod:UpdateSnapshot', updateSnapshot_retentionPeriod - The new retention period of the snapshot.
UpdateSnapshot, updateSnapshot_snapshotName - The name of the snapshot.
data UpdateSnapshotResponse Source #
See: newUpdateSnapshotResponse smart constructor.
Constructors
| UpdateSnapshotResponse' (Maybe Snapshot) Int |
Instances
newUpdateSnapshotResponse Source #
Create a value of UpdateSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:UpdateSnapshotResponse', updateSnapshotResponse_snapshot - The updated snapshot object.
$sel:httpStatus:UpdateSnapshotResponse', updateSnapshotResponse_httpStatus - The response's http status code.
UpdateUsageLimit
data UpdateUsageLimit Source #
See: newUpdateUsageLimit smart constructor.
Constructors
| UpdateUsageLimit' (Maybe Integer) (Maybe UsageLimitBreachAction) Text |
Instances
Arguments
| :: Text | |
| -> UpdateUsageLimit |
Create a value of UpdateUsageLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUsageLimit, updateUsageLimit_amount - The new 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.
UpdateUsageLimit, updateUsageLimit_breachAction - The new action that Amazon Redshift Serverless takes when the limit is
reached.
UpdateUsageLimit, updateUsageLimit_usageLimitId - The identifier of the usage limit to update.
data UpdateUsageLimitResponse Source #
See: newUpdateUsageLimitResponse smart constructor.
Constructors
| UpdateUsageLimitResponse' (Maybe UsageLimit) Int |
Instances
newUpdateUsageLimitResponse Source #
Create a value of UpdateUsageLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:usageLimit:UpdateUsageLimitResponse', updateUsageLimitResponse_usageLimit - The updated usage limit object.
$sel:httpStatus:UpdateUsageLimitResponse', updateUsageLimitResponse_httpStatus - The response's http status code.
UpdateWorkgroup
data UpdateWorkgroup Source #
See: newUpdateWorkgroup smart constructor.
Constructors
| UpdateWorkgroup' (Maybe Int) (Maybe [ConfigParameter]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateWorkgroup |
Create a value of UpdateWorkgroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorkgroup, updateWorkgroup_baseCapacity - The new base data warehouse capacity in Redshift Processing Units
(RPUs).
UpdateWorkgroup, updateWorkgroup_configParameters - 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.
UpdateWorkgroup, updateWorkgroup_enhancedVpcRouting - 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.
UpdateWorkgroup, updateWorkgroup_port - The custom port to use when connecting to a workgroup. Valid port ranges
are 5431-5455 and 8191-8215. The default is 5439.
UpdateWorkgroup, updateWorkgroup_publiclyAccessible - A value that specifies whether the workgroup can be accessible from a
public network.
UpdateWorkgroup, updateWorkgroup_securityGroupIds - An array of security group IDs to associate with the workgroup.
UpdateWorkgroup, updateWorkgroup_subnetIds - An array of VPC subnet IDs to associate with the workgroup.
UpdateWorkgroup, updateWorkgroup_workgroupName - The name of the workgroup to update.
data UpdateWorkgroupResponse Source #
See: newUpdateWorkgroupResponse smart constructor.
Constructors
| UpdateWorkgroupResponse' Int Workgroup |
Instances
newUpdateWorkgroupResponse Source #
Arguments
| :: Int | |
| -> Workgroup | |
| -> UpdateWorkgroupResponse |
Create a value of UpdateWorkgroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateWorkgroupResponse', updateWorkgroupResponse_httpStatus - The response's http status code.
$sel:workgroup:UpdateWorkgroupResponse', updateWorkgroupResponse_workgroup - The updated workgroup object.
Types
LogExport
Constructors
| LogExport' | |
Fields | |
Bundled Patterns
| pattern LogExport_Connectionlog :: LogExport | |
| pattern LogExport_Useractivitylog :: LogExport | |
| pattern LogExport_Userlog :: LogExport |
Instances
NamespaceStatus
newtype NamespaceStatus Source #
Constructors
| NamespaceStatus' | |
Fields | |
Bundled Patterns
| pattern NamespaceStatus_AVAILABLE :: NamespaceStatus | |
| pattern NamespaceStatus_DELETING :: NamespaceStatus | |
| pattern NamespaceStatus_MODIFYING :: NamespaceStatus |
Instances
SnapshotStatus
newtype SnapshotStatus Source #
Constructors
| SnapshotStatus' | |
Fields | |
Bundled Patterns
| pattern SnapshotStatus_AVAILABLE :: SnapshotStatus | |
| pattern SnapshotStatus_CANCELLED :: SnapshotStatus | |
| pattern SnapshotStatus_COPYING :: SnapshotStatus | |
| pattern SnapshotStatus_CREATING :: SnapshotStatus | |
| pattern SnapshotStatus_DELETED :: SnapshotStatus | |
| pattern SnapshotStatus_FAILED :: SnapshotStatus |
Instances
UsageLimitBreachAction
newtype UsageLimitBreachAction Source #
Constructors
| UsageLimitBreachAction' | |
Fields | |
Bundled Patterns
| pattern UsageLimitBreachAction_Deactivate :: UsageLimitBreachAction | |
| pattern UsageLimitBreachAction_Emit_metric :: UsageLimitBreachAction | |
| pattern UsageLimitBreachAction_Log :: UsageLimitBreachAction |
Instances
UsageLimitPeriod
newtype UsageLimitPeriod Source #
Constructors
| UsageLimitPeriod' | |
Fields | |
Bundled Patterns
| pattern UsageLimitPeriod_Daily :: UsageLimitPeriod | |
| pattern UsageLimitPeriod_Monthly :: UsageLimitPeriod | |
| pattern UsageLimitPeriod_Weekly :: UsageLimitPeriod |
Instances
UsageLimitUsageType
newtype UsageLimitUsageType Source #
Constructors
| UsageLimitUsageType' | |
Fields | |
Bundled Patterns
| pattern UsageLimitUsageType_Cross_region_datasharing :: UsageLimitUsageType | |
| pattern UsageLimitUsageType_Serverless_compute :: UsageLimitUsageType |
Instances
WorkgroupStatus
newtype WorkgroupStatus Source #
Constructors
| WorkgroupStatus' | |
Fields | |
Bundled Patterns
| pattern WorkgroupStatus_AVAILABLE :: WorkgroupStatus | |
| pattern WorkgroupStatus_CREATING :: WorkgroupStatus | |
| pattern WorkgroupStatus_DELETING :: WorkgroupStatus | |
| pattern WorkgroupStatus_MODIFYING :: WorkgroupStatus |
Instances
ConfigParameter
data ConfigParameter Source #
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
See: newConfigParameter smart constructor.
Constructors
| ConfigParameter' (Maybe Text) (Maybe Text) |
Instances
newConfigParameter :: ConfigParameter Source #
Create a value of ConfigParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameterKey:ConfigParameter', configParameter_parameterKey - The key of the parameter. The options are datestyle,
enable_user_activity_logging, query_group, search_path, and
max_query_execution_time.
$sel:parameterValue:ConfigParameter', configParameter_parameterValue - The value of the parameter to set.
Endpoint
The VPC endpoint object.
See: newEndpoint smart constructor.
Instances
| FromJSON Endpoint Source # | |
| Generic Endpoint Source # | |
| Read Endpoint Source # | |
| Show Endpoint Source # | |
| NFData Endpoint Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Endpoint | |
| Eq Endpoint Source # | |
| Hashable Endpoint Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Endpoint | |
| type Rep Endpoint Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.RedshiftServerLess.Types.Endpoint" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "vpcEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcEndpoint]))))) | |
newEndpoint :: Endpoint Source #
Create a value of Endpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:Endpoint', endpoint_address - The DNS address of the VPC endpoint.
$sel:port:Endpoint', endpoint_port - The port that Amazon Redshift Serverless listens on.
$sel:vpcEndpoints:Endpoint', endpoint_vpcEndpoints - An array of VpcEndpoint objects.
EndpointAccess
data EndpointAccess Source #
Information about an Amazon Redshift Serverless VPC endpoint.
See: newEndpointAccess smart constructor.
Constructors
| EndpointAccess' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe VpcEndpoint) (Maybe [VpcSecurityGroupMembership]) (Maybe Text) |
Instances
newEndpointAccess :: EndpointAccess Source #
Create a value of EndpointAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:EndpointAccess', endpointAccess_address - The DNS address of the endpoint.
$sel:endpointArn:EndpointAccess', endpointAccess_endpointArn - The Amazon Resource Name (ARN) of the VPC endpoint.
$sel:endpointCreateTime:EndpointAccess', endpointAccess_endpointCreateTime - The time that the endpoint was created.
$sel:endpointName:EndpointAccess', endpointAccess_endpointName - The name of the VPC endpoint.
$sel:endpointStatus:EndpointAccess', endpointAccess_endpointStatus - The status of the VPC endpoint.
$sel:port:EndpointAccess', endpointAccess_port - The port number on which Amazon Redshift Serverless accepts incoming
connections.
$sel:subnetIds:EndpointAccess', endpointAccess_subnetIds - The unique identifier of subnets where Amazon Redshift Serverless choose
to deploy the VPC endpoint.
$sel:vpcEndpoint:EndpointAccess', endpointAccess_vpcEndpoint - The connection endpoint for connecting to Amazon Redshift Serverless.
$sel:vpcSecurityGroups:EndpointAccess', endpointAccess_vpcSecurityGroups - The security groups associated with the endpoint.
$sel:workgroupName:EndpointAccess', endpointAccess_workgroupName - The name of the workgroup associated with the endpoint.
Namespace
A collection of database objects and users.
See: newNamespace smart constructor.
Constructors
| Namespace' (Maybe (Sensitive Text)) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [LogExport]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NamespaceStatus) |
Instances
newNamespace :: Namespace Source #
Create a value of Namespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:adminUsername:Namespace', namespace_adminUsername - The username of the administrator for the first database created in the
namespace.
$sel:creationDate:Namespace', namespace_creationDate - The date of when the namespace was created.
$sel:dbName:Namespace', namespace_dbName - The name of the first database created in the namespace.
$sel:defaultIamRoleArn:Namespace', namespace_defaultIamRoleArn - The Amazon Resource Name (ARN) of the IAM role to set as a default in
the namespace.
$sel:iamRoles:Namespace', namespace_iamRoles - A list of IAM roles to associate with the namespace.
$sel:kmsKeyId:Namespace', namespace_kmsKeyId - The ID of the Amazon Web Services Key Management Service key used to
encrypt your data.
$sel:logExports:Namespace', namespace_logExports - The types of logs the namespace can export. Available export types are
User log, Connection log, and User activity log.
$sel:namespaceArn:Namespace', namespace_namespaceArn - The Amazon Resource Name (ARN) associated with a namespace.
$sel:namespaceId:Namespace', namespace_namespaceId - The unique identifier of a namespace.
$sel:namespaceName:Namespace', namespace_namespaceName - 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
in the Amazon Redshift Database Developer Guide.
$sel:status:Namespace', namespace_status - The status of the namespace.
NetworkInterface
data NetworkInterface Source #
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
See: newNetworkInterface smart constructor.
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZone:NetworkInterface', networkInterface_availabilityZone - The availability Zone.
$sel:networkInterfaceId:NetworkInterface', networkInterface_networkInterfaceId - The unique identifier of the network interface.
$sel:privateIpAddress:NetworkInterface', networkInterface_privateIpAddress - The IPv4 address of the network interface within the subnet.
$sel:subnetId:NetworkInterface', networkInterface_subnetId - The unique identifier of the subnet.
RecoveryPoint
data RecoveryPoint Source #
The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
See: newRecoveryPoint smart constructor.
Constructors
| RecoveryPoint' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Double) (Maybe Text) |
Instances
newRecoveryPoint :: RecoveryPoint Source #
Create a value of RecoveryPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespaceArn:RecoveryPoint', recoveryPoint_namespaceArn - The Amazon Resource Name (ARN) of the namespace the recovery point is
associated with.
$sel:namespaceName:RecoveryPoint', recoveryPoint_namespaceName - The name of the namespace the recovery point is associated with.
$sel:recoveryPointCreateTime:RecoveryPoint', recoveryPoint_recoveryPointCreateTime - The time the recovery point is created.
$sel:recoveryPointId:RecoveryPoint', recoveryPoint_recoveryPointId - The unique identifier of the recovery point.
$sel:totalSizeInMegaBytes:RecoveryPoint', recoveryPoint_totalSizeInMegaBytes - The total size of the data in the recovery point in megabytes.
$sel:workgroupName:RecoveryPoint', recoveryPoint_workgroupName - The name of the workgroup the recovery point is associated with.
ResourcePolicy
data ResourcePolicy Source #
The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
See: newResourcePolicy smart constructor.
Constructors
| ResourcePolicy' (Maybe Text) (Maybe Text) |
Instances
newResourcePolicy :: ResourcePolicy Source #
Create a value of ResourcePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:ResourcePolicy', resourcePolicy_policy - The resource policy.
$sel:resourceArn:ResourcePolicy', resourcePolicy_resourceArn - The Amazon Resource Name (ARN) of the policy.
Snapshot
A snapshot object that contains databases.
See: newSnapshot smart constructor.
Constructors
| Snapshot' (Maybe [Text]) (Maybe [Text]) (Maybe Double) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe ISO8601) (Maybe SnapshotStatus) (Maybe Double) |
Instances
newSnapshot :: Snapshot Source #
Create a value of Snapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountsWithProvisionedRestoreAccess:Snapshot', snapshot_accountsWithProvisionedRestoreAccess - All of the Amazon Web Services accounts that have access to restore a
snapshot to a provisioned cluster.
$sel:accountsWithRestoreAccess:Snapshot', snapshot_accountsWithRestoreAccess - All of the Amazon Web Services accounts that have access to restore a
snapshot to a namespace.
$sel:actualIncrementalBackupSizeInMegaBytes:Snapshot', snapshot_actualIncrementalBackupSizeInMegaBytes - The size of the incremental backup in megabytes.
$sel:adminUsername:Snapshot', snapshot_adminUsername - The username of the database within a snapshot.
$sel:backupProgressInMegaBytes:Snapshot', snapshot_backupProgressInMegaBytes - The size in megabytes of the data that has been backed up to a snapshot.
$sel:currentBackupRateInMegaBytesPerSecond:Snapshot', snapshot_currentBackupRateInMegaBytesPerSecond - The rate at which data is backed up into a snapshot in megabytes per
second.
$sel:elapsedTimeInSeconds:Snapshot', snapshot_elapsedTimeInSeconds - The amount of time it took to back up data into a snapshot.
$sel:estimatedSecondsToCompletion:Snapshot', snapshot_estimatedSecondsToCompletion - The estimated amount of seconds until the snapshot completes backup.
$sel:kmsKeyId:Snapshot', snapshot_kmsKeyId - The unique identifier of the KMS key used to encrypt the snapshot.
$sel:namespaceArn:Snapshot', snapshot_namespaceArn - The Amazon Resource Name (ARN) of the namespace the snapshot was created
from.
$sel:namespaceName:Snapshot', snapshot_namespaceName - The name of the namepsace.
$sel:ownerAccount:Snapshot', snapshot_ownerAccount - The owner Amazon Web Services; account of the snapshot.
$sel:snapshotArn:Snapshot', snapshot_snapshotArn - The Amazon Resource Name (ARN) of the snapshot.
$sel:snapshotCreateTime:Snapshot', snapshot_snapshotCreateTime - The timestamp of when the snapshot was created.
$sel:snapshotName:Snapshot', snapshot_snapshotName - The name of the snapshot.
$sel:snapshotRemainingDays:Snapshot', snapshot_snapshotRemainingDays - The amount of days until the snapshot is deleted.
$sel:snapshotRetentionPeriod:Snapshot', snapshot_snapshotRetentionPeriod - The period of time, in days, of how long the snapshot is retained.
$sel:snapshotRetentionStartTime:Snapshot', snapshot_snapshotRetentionStartTime - The timestamp of when data within the snapshot started getting retained.
$sel:status:Snapshot', snapshot_status - The status of the snapshot.
$sel:totalBackupSizeInMegaBytes:Snapshot', snapshot_totalBackupSizeInMegaBytes - The total size, in megabytes, of how big the snapshot is.
TableRestoreStatus
data TableRestoreStatus Source #
Contains information about a table restore request.
See: newTableRestoreStatus smart constructor.
Constructors
| TableRestoreStatus' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) |
Instances
newTableRestoreStatus :: TableRestoreStatus Source #
Create a value of TableRestoreStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:TableRestoreStatus', tableRestoreStatus_message - A description of the status of the table restore request. Status values
include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.
$sel:namespaceName:TableRestoreStatus', tableRestoreStatus_namespaceName - The namespace of the table being restored from.
$sel:newTableName':TableRestoreStatus', tableRestoreStatus_newTableName - The name of the table to create from the restore operation.
$sel:progressInMegaBytes:TableRestoreStatus', tableRestoreStatus_progressInMegaBytes - The amount of data restored to the new table so far, in megabytes (MB).
$sel:requestTime:TableRestoreStatus', tableRestoreStatus_requestTime - The time that the table restore request was made, in Universal
Coordinated Time (UTC).
$sel:snapshotName:TableRestoreStatus', tableRestoreStatus_snapshotName - The name of the snapshot being restored from.
$sel:sourceDatabaseName:TableRestoreStatus', tableRestoreStatus_sourceDatabaseName - The name of the source database being restored from.
$sel:sourceSchemaName:TableRestoreStatus', tableRestoreStatus_sourceSchemaName - The name of the source schema being restored from.
$sel:sourceTableName:TableRestoreStatus', tableRestoreStatus_sourceTableName - The name of the source table being restored from.
$sel:status:TableRestoreStatus', tableRestoreStatus_status - A value that describes the current state of the table restore request.
Possible values include SUCCEEDED, FAILED, CANCELED, PENDING,
IN_PROGRESS.
$sel:tableRestoreRequestId:TableRestoreStatus', tableRestoreStatus_tableRestoreRequestId - The ID of the RestoreTableFromSnapshot request.
$sel:targetDatabaseName:TableRestoreStatus', tableRestoreStatus_targetDatabaseName - The name of the database to restore to.
$sel:targetSchemaName:TableRestoreStatus', tableRestoreStatus_targetSchemaName - The name of the schema to restore to.
$sel:totalDataInMegaBytes:TableRestoreStatus', tableRestoreStatus_totalDataInMegaBytes - The total amount of data to restore to the new table, in megabytes (MB).
$sel:workgroupName:TableRestoreStatus', tableRestoreStatus_workgroupName - The name of the workgroup being restored from.
Tag
A map of key-value pairs.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.RedshiftServerLess.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.RedshiftServerLess.Types.Tag" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key to use in the tag.
$sel:value:Tag', tag_value - The value of the tag.
UsageLimit
data UsageLimit Source #
The usage limit object.
See: newUsageLimit smart constructor.
Constructors
| UsageLimit' (Maybe Integer) (Maybe UsageLimitBreachAction) (Maybe UsageLimitPeriod) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UsageLimitUsageType) |
Instances
newUsageLimit :: UsageLimit Source #
Create a value of UsageLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amount:UsageLimit', usageLimit_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.
$sel:breachAction:UsageLimit', usageLimit_breachAction - The action that Amazon Redshift Serverless takes when the limit is
reached.
$sel:period:UsageLimit', usageLimit_period - The time period that the amount applies to. A weekly period begins on
Sunday. The default is monthly.
$sel:resourceArn:UsageLimit', usageLimit_resourceArn - The Amazon Resource Name (ARN) that identifies the Amazon Redshift
Serverless resource.
$sel:usageLimitArn:UsageLimit', usageLimit_usageLimitArn - The Amazon Resource Name (ARN) of the resource associated with the usage
limit.
$sel:usageLimitId:UsageLimit', usageLimit_usageLimitId - The identifier of the usage limit.
$sel:usageType:UsageLimit', usageLimit_usageType - The Amazon Redshift Serverless feature to limit.
VpcEndpoint
data VpcEndpoint Source #
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
See: newVpcEndpoint smart constructor.
Constructors
| VpcEndpoint' (Maybe [NetworkInterface]) (Maybe Text) (Maybe Text) |
Instances
newVpcEndpoint :: VpcEndpoint Source #
Create a value of VpcEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:networkInterfaces:VpcEndpoint', vpcEndpoint_networkInterfaces - One or more network interfaces of the endpoint. Also known as an
interface endpoint.
$sel:vpcEndpointId:VpcEndpoint', vpcEndpoint_vpcEndpointId - The connection endpoint ID for connecting to Amazon Redshift Serverless.
$sel:vpcId:VpcEndpoint', vpcEndpoint_vpcId - The VPC identifier that the endpoint is associated with.
VpcSecurityGroupMembership
data VpcSecurityGroupMembership Source #
Describes the members of a VPC security group.
See: newVpcSecurityGroupMembership smart constructor.
Constructors
| VpcSecurityGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newVpcSecurityGroupMembership :: VpcSecurityGroupMembership Source #
Create a value of VpcSecurityGroupMembership with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:VpcSecurityGroupMembership', vpcSecurityGroupMembership_status - The status of the VPC security group.
$sel:vpcSecurityGroupId:VpcSecurityGroupMembership', vpcSecurityGroupMembership_vpcSecurityGroupId - The unique identifier of the VPC security group.
Workgroup
The collection of computing resources from which an endpoint is created.
See: newWorkgroup smart constructor.
Constructors
| Workgroup' (Maybe Int) (Maybe [ConfigParameter]) (Maybe ISO8601) (Maybe Endpoint) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe [Text]) (Maybe WorkgroupStatus) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newWorkgroup :: Workgroup Source #
Create a value of Workgroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:baseCapacity:Workgroup', workgroup_baseCapacity - The base data warehouse capacity of the workgroup in Redshift Processing
Units (RPUs).
$sel:configParameters:Workgroup', workgroup_configParameters - 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.
$sel:creationDate:Workgroup', workgroup_creationDate - The creation date of the workgroup.
$sel:endpoint:Workgroup', workgroup_endpoint - The endpoint that is created from the workgroup.
$sel:enhancedVpcRouting:Workgroup', workgroup_enhancedVpcRouting - The value that specifies whether to enable enhanced virtual private
cloud (VPC) routing, which forces Amazon Redshift Serverless to route
traffic through your VPC.
$sel:namespaceName:Workgroup', workgroup_namespaceName - The namespace the workgroup is associated with.
Workgroup, workgroup_port - The custom port to use when connecting to a workgroup. Valid port ranges
are 5431-5455 and 8191-8215. The default is 5439.
$sel:publiclyAccessible:Workgroup', workgroup_publiclyAccessible - A value that specifies whether the workgroup can be accessible from a
public network
$sel:securityGroupIds:Workgroup', workgroup_securityGroupIds - An array of security group IDs to associate with the workgroup.
$sel:status:Workgroup', workgroup_status - The status of the workgroup.
$sel:subnetIds:Workgroup', workgroup_subnetIds - An array of subnet IDs the workgroup is associated with.
$sel:workgroupArn:Workgroup', workgroup_workgroupArn - The Amazon Resource Name (ARN) that links to the workgroup.
$sel:workgroupId:Workgroup', workgroup_workgroupId - The unique identifier of the workgroup.
$sel:workgroupName:Workgroup', workgroup_workgroupName - The name of the workgroup.