| 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.S3Outposts
Contents
Description
Derived from API version 2017-07-25 of the AWS service descriptions, licensed under Apache 2.0.
Amazon S3 on Outposts provides access to S3 on Outposts operations.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateEndpoint = CreateEndpoint' (Maybe EndpointAccessType) (Maybe Text) Text Text Text
- newCreateEndpoint :: Text -> Text -> Text -> CreateEndpoint
- data CreateEndpointResponse = CreateEndpointResponse' (Maybe Text) Int
- newCreateEndpointResponse :: Int -> CreateEndpointResponse
- data DeleteEndpoint = DeleteEndpoint' Text Text
- newDeleteEndpoint :: Text -> Text -> DeleteEndpoint
- data DeleteEndpointResponse = DeleteEndpointResponse' {
- newDeleteEndpointResponse :: DeleteEndpointResponse
- data ListEndpoints = ListEndpoints' (Maybe Natural) (Maybe Text)
- newListEndpoints :: ListEndpoints
- data ListEndpointsResponse = ListEndpointsResponse' (Maybe [Endpoint]) (Maybe Text) Int
- newListEndpointsResponse :: Int -> ListEndpointsResponse
- data ListSharedEndpoints = ListSharedEndpoints' (Maybe Natural) (Maybe Text) Text
- newListSharedEndpoints :: Text -> ListSharedEndpoints
- data ListSharedEndpointsResponse = ListSharedEndpointsResponse' (Maybe [Endpoint]) (Maybe Text) Int
- newListSharedEndpointsResponse :: Int -> ListSharedEndpointsResponse
- newtype EndpointAccessType where
- newtype EndpointStatus where
- EndpointStatus' { }
- pattern EndpointStatus_Available :: EndpointStatus
- pattern EndpointStatus_Deleting :: EndpointStatus
- pattern EndpointStatus_Pending :: EndpointStatus
- data Endpoint = Endpoint' (Maybe EndpointAccessType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [NetworkInterface]) (Maybe Text) (Maybe Text) (Maybe EndpointStatus) (Maybe Text) (Maybe Text)
- newEndpoint :: Endpoint
- data NetworkInterface = NetworkInterface' (Maybe Text)
- newNetworkInterface :: NetworkInterface
Service Configuration
defaultService :: Service Source #
API version 2017-07-25 of the Amazon S3 on Outposts 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 S3Outposts.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access was denied for this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
There was a conflict with this action, and it could not be completed.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an exception with the internal server.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource was not found.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
There was an exception validating this data.
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.
CreateEndpoint
data CreateEndpoint Source #
See: newCreateEndpoint smart constructor.
Constructors
| CreateEndpoint' (Maybe EndpointAccessType) (Maybe Text) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateEndpoint |
Create a value of CreateEndpoint 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:
CreateEndpoint, createEndpoint_accessType - The type of access for the network connectivity for the Amazon S3 on
Outposts endpoint. To use the Amazon Web Services VPC, choose Private.
To use the endpoint with an on-premises network, choose
CustomerOwnedIp. If you choose CustomerOwnedIp, you must also
provide the customer-owned IP address pool (CoIP pool).
Private is the default access type value.
CreateEndpoint, createEndpoint_customerOwnedIpv4Pool - The ID of the customer-owned IPv4 address pool (CoIP pool) for the
endpoint. IP addresses are allocated from this pool for the endpoint.
$sel:outpostId:CreateEndpoint', createEndpoint_outpostId - The ID of the Outposts.
CreateEndpoint, createEndpoint_subnetId - The ID of the subnet in the selected VPC. The endpoint subnet must
belong to the Outpost that has Amazon S3 on Outposts provisioned.
CreateEndpoint, createEndpoint_securityGroupId - The ID of the security group to use with the endpoint.
data CreateEndpointResponse Source #
See: newCreateEndpointResponse smart constructor.
Constructors
| CreateEndpointResponse' (Maybe Text) Int |
Instances
newCreateEndpointResponse Source #
Create a value of CreateEndpointResponse 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:
CreateEndpointResponse, createEndpointResponse_endpointArn - The Amazon Resource Name (ARN) of the endpoint.
$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.
DeleteEndpoint
data DeleteEndpoint Source #
See: newDeleteEndpoint smart constructor.
Constructors
| DeleteEndpoint' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteEndpoint |
Create a value of DeleteEndpoint 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:endpointId:DeleteEndpoint', deleteEndpoint_endpointId - The ID of the endpoint.
$sel:outpostId:DeleteEndpoint', deleteEndpoint_outpostId - The ID of the Outposts.
data DeleteEndpointResponse Source #
See: newDeleteEndpointResponse smart constructor.
Constructors
| DeleteEndpointResponse' | |
Instances
| Generic DeleteEndpointResponse Source # | |
Defined in Amazonka.S3Outposts.DeleteEndpoint Associated Types type Rep DeleteEndpointResponse :: Type -> Type # Methods from :: DeleteEndpointResponse -> Rep DeleteEndpointResponse x # to :: Rep DeleteEndpointResponse x -> DeleteEndpointResponse # | |
| Read DeleteEndpointResponse Source # | |
Defined in Amazonka.S3Outposts.DeleteEndpoint | |
| Show DeleteEndpointResponse Source # | |
Defined in Amazonka.S3Outposts.DeleteEndpoint Methods showsPrec :: Int -> DeleteEndpointResponse -> ShowS # show :: DeleteEndpointResponse -> String # showList :: [DeleteEndpointResponse] -> ShowS # | |
| NFData DeleteEndpointResponse Source # | |
Defined in Amazonka.S3Outposts.DeleteEndpoint Methods rnf :: DeleteEndpointResponse -> () # | |
| Eq DeleteEndpointResponse Source # | |
Defined in Amazonka.S3Outposts.DeleteEndpoint Methods (==) :: DeleteEndpointResponse -> DeleteEndpointResponse -> Bool # (/=) :: DeleteEndpointResponse -> DeleteEndpointResponse -> Bool # | |
| type Rep DeleteEndpointResponse Source # | |
newDeleteEndpointResponse :: DeleteEndpointResponse Source #
Create a value of DeleteEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListEndpoints (Paginated)
data ListEndpoints Source #
See: newListEndpoints smart constructor.
Constructors
| ListEndpoints' (Maybe Natural) (Maybe Text) |
Instances
newListEndpoints :: ListEndpoints Source #
Create a value of ListEndpoints 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:ListEndpoints', listEndpoints_maxResults - The maximum number of endpoints that will be returned in the response.
ListEndpoints, listEndpoints_nextToken - If a previous response from this operation included a NextToken value,
provide that value here to retrieve the next page of results.
data ListEndpointsResponse Source #
See: newListEndpointsResponse smart constructor.
Instances
newListEndpointsResponse Source #
Create a value of ListEndpointsResponse 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:endpoints:ListEndpointsResponse', listEndpointsResponse_endpoints - The list of endpoints associated with the specified Outpost.
ListEndpoints, listEndpointsResponse_nextToken - If the number of endpoints associated with the specified Outpost exceeds
MaxResults, you can include this value in subsequent calls to this
operation to retrieve more results.
$sel:httpStatus:ListEndpointsResponse', listEndpointsResponse_httpStatus - The response's http status code.
ListSharedEndpoints (Paginated)
newListSharedEndpoints Source #
Arguments
| :: Text | |
| -> ListSharedEndpoints |
Create a value of ListSharedEndpoints 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:ListSharedEndpoints', listSharedEndpoints_maxResults - The maximum number of endpoints that will be returned in the response.
ListSharedEndpoints, listSharedEndpoints_nextToken - If a previous response from this operation included a NextToken value,
you can provide that value here to retrieve the next page of results.
$sel:outpostId:ListSharedEndpoints', listSharedEndpoints_outpostId - The ID of the Amazon Web Services Outpost.
data ListSharedEndpointsResponse Source #
See: newListSharedEndpointsResponse smart constructor.
Instances
newListSharedEndpointsResponse Source #
Create a value of ListSharedEndpointsResponse 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:endpoints:ListSharedEndpointsResponse', listSharedEndpointsResponse_endpoints - The list of endpoints associated with the specified Outpost that have
been shared by Amazon Web Services Resource Access Manager (RAM).
ListSharedEndpoints, listSharedEndpointsResponse_nextToken - If the number of endpoints associated with the specified Outpost exceeds
MaxResults, you can include this value in subsequent calls to this
operation to retrieve more results.
$sel:httpStatus:ListSharedEndpointsResponse', listSharedEndpointsResponse_httpStatus - The response's http status code.
Types
EndpointAccessType
newtype EndpointAccessType Source #
Constructors
| EndpointAccessType' | |
Fields | |
Bundled Patterns
| pattern EndpointAccessType_CustomerOwnedIp :: EndpointAccessType | |
| pattern EndpointAccessType_Private :: EndpointAccessType |
Instances
EndpointStatus
newtype EndpointStatus Source #
Constructors
| EndpointStatus' | |
Fields | |
Bundled Patterns
| pattern EndpointStatus_Available :: EndpointStatus | |
| pattern EndpointStatus_Deleting :: EndpointStatus | |
| pattern EndpointStatus_Pending :: EndpointStatus |
Instances
Endpoint
Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only access points in the Amazon Simple Storage Service User Guide.
See: newEndpoint smart constructor.
Constructors
| Endpoint' (Maybe EndpointAccessType) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [NetworkInterface]) (Maybe Text) (Maybe Text) (Maybe EndpointStatus) (Maybe Text) (Maybe Text) |
Instances
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:accessType:Endpoint', endpoint_accessType - The type of connectivity used to access the Amazon S3 on Outposts
endpoint.
$sel:cidrBlock:Endpoint', endpoint_cidrBlock - The VPC CIDR committed by this endpoint.
$sel:creationTime:Endpoint', endpoint_creationTime - The time the endpoint was created.
$sel:customerOwnedIpv4Pool:Endpoint', endpoint_customerOwnedIpv4Pool - The ID of the customer-owned IPv4 address pool used for the endpoint.
$sel:endpointArn:Endpoint', endpoint_endpointArn - The Amazon Resource Name (ARN) of the endpoint.
$sel:networkInterfaces:Endpoint', endpoint_networkInterfaces - The network interface of the endpoint.
$sel:outpostsId:Endpoint', endpoint_outpostsId - The ID of the Outposts.
$sel:securityGroupId:Endpoint', endpoint_securityGroupId - The ID of the security group used for the endpoint.
$sel:status:Endpoint', endpoint_status - The status of the endpoint.
$sel:subnetId:Endpoint', endpoint_subnetId - The ID of the subnet used for the endpoint.
$sel:vpcId:Endpoint', endpoint_vpcId - The ID of the VPC used for the endpoint.
NetworkInterface
data NetworkInterface Source #
The container for the network interface.
See: newNetworkInterface smart constructor.
Constructors
| NetworkInterface' (Maybe Text) |
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:networkInterfaceId:NetworkInterface', networkInterface_networkInterfaceId - The ID for the network interface.