Amazonka.S3Outposts.Lens

Operations

CreateEndpoint

createEndpoint_accessType :: Lens' CreateEndpoint (Maybe EndpointAccessType)

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_customerOwnedIpv4Pool :: Lens' CreateEndpoint (Maybe Text)

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

createEndpoint_outpostId :: Lens' CreateEndpoint Text

The ID of the Outposts.

createEndpoint_subnetId :: Lens' CreateEndpoint Text

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_securityGroupId :: Lens' CreateEndpoint Text

The ID of the security group to use with the endpoint.

createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text)

The Amazon Resource Name (ARN) of the endpoint.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int

The response's http status code.

DeleteEndpoint

deleteEndpoint_endpointId :: Lens' DeleteEndpoint Text

The ID of the endpoint.

deleteEndpoint_outpostId :: Lens' DeleteEndpoint Text

The ID of the Outposts.

ListEndpoints

listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural)

The maximum number of endpoints that will be returned in the response.

listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text)

If a previous response from this operation included a NextToken value, provide that value here to retrieve the next page of results.

listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse (Maybe [Endpoint])

The list of endpoints associated with the specified Outpost.

listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text)

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.

listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int

The response's http status code.

ListSharedEndpoints

listSharedEndpoints_maxResults :: Lens' ListSharedEndpoints (Maybe Natural)

The maximum number of endpoints that will be returned in the response.

listSharedEndpoints_nextToken :: Lens' ListSharedEndpoints (Maybe Text)

If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.

listSharedEndpoints_outpostId :: Lens' ListSharedEndpoints Text

The ID of the Amazon Web Services Outpost.

listSharedEndpointsResponse_endpoints :: Lens' ListSharedEndpointsResponse (Maybe [Endpoint])

The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).

listSharedEndpointsResponse_nextToken :: Lens' ListSharedEndpointsResponse (Maybe Text)

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.

listSharedEndpointsResponse_httpStatus :: Lens' ListSharedEndpointsResponse Int

The response's http status code.

Types

Endpoint

endpoint_accessType :: Lens' Endpoint (Maybe EndpointAccessType)

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

endpoint_cidrBlock :: Lens' Endpoint (Maybe Text)

The VPC CIDR committed by this endpoint.

endpoint_creationTime :: Lens' Endpoint (Maybe UTCTime)

The time the endpoint was created.

endpoint_customerOwnedIpv4Pool :: Lens' Endpoint (Maybe Text)

The ID of the customer-owned IPv4 address pool used for the endpoint.

endpoint_endpointArn :: Lens' Endpoint (Maybe Text)

The Amazon Resource Name (ARN) of the endpoint.

endpoint_networkInterfaces :: Lens' Endpoint (Maybe [NetworkInterface])

The network interface of the endpoint.

endpoint_outpostsId :: Lens' Endpoint (Maybe Text)

The ID of the Outposts.

endpoint_securityGroupId :: Lens' Endpoint (Maybe Text)

The ID of the security group used for the endpoint.

endpoint_status :: Lens' Endpoint (Maybe EndpointStatus)

The status of the endpoint.

endpoint_subnetId :: Lens' Endpoint (Maybe Text)

The ID of the subnet used for the endpoint.

endpoint_vpcId :: Lens' Endpoint (Maybe Text)

The ID of the VPC used for the endpoint.

NetworkInterface

networkInterface_networkInterfaceId :: Lens' NetworkInterface (Maybe Text)

The ID for the network interface.