Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
Synopsis
- data CreateConnection = CreateConnection' {}
- newCreateConnection :: Text -> ConnectionAuthorizationType -> CreateConnectionAuthRequestParameters -> CreateConnection
- createConnection_description :: Lens' CreateConnection (Maybe Text)
- createConnection_name :: Lens' CreateConnection Text
- createConnection_authorizationType :: Lens' CreateConnection ConnectionAuthorizationType
- createConnection_authParameters :: Lens' CreateConnection CreateConnectionAuthRequestParameters
- data CreateConnectionResponse = CreateConnectionResponse' {}
- newCreateConnectionResponse :: Int -> CreateConnectionResponse
- createConnectionResponse_creationTime :: Lens' CreateConnectionResponse (Maybe UTCTime)
- createConnectionResponse_lastModifiedTime :: Lens' CreateConnectionResponse (Maybe UTCTime)
- createConnectionResponse_connectionArn :: Lens' CreateConnectionResponse (Maybe Text)
- createConnectionResponse_connectionState :: Lens' CreateConnectionResponse (Maybe ConnectionState)
- createConnectionResponse_httpStatus :: Lens' CreateConnectionResponse Int
Creating a Request
data CreateConnection Source #
See: newCreateConnection
smart constructor.
CreateConnection' | |
|
Instances
Create a value of CreateConnection
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:description:CreateConnection'
, createConnection_description
- A description for the connection to create.
$sel:name:CreateConnection'
, createConnection_name
- The name for the connection to create.
$sel:authorizationType:CreateConnection'
, createConnection_authorizationType
- The type of authorization to use for the connection.
$sel:authParameters:CreateConnection'
, createConnection_authParameters
- A CreateConnectionAuthRequestParameters
object that contains the
authorization parameters to use to authorize with the endpoint.
Request Lenses
createConnection_description :: Lens' CreateConnection (Maybe Text) Source #
A description for the connection to create.
createConnection_name :: Lens' CreateConnection Text Source #
The name for the connection to create.
createConnection_authorizationType :: Lens' CreateConnection ConnectionAuthorizationType Source #
The type of authorization to use for the connection.
createConnection_authParameters :: Lens' CreateConnection CreateConnectionAuthRequestParameters Source #
A CreateConnectionAuthRequestParameters
object that contains the
authorization parameters to use to authorize with the endpoint.
Destructuring the Response
data CreateConnectionResponse Source #
See: newCreateConnectionResponse
smart constructor.
CreateConnectionResponse' | |
|
Instances
newCreateConnectionResponse Source #
Create a value of CreateConnectionResponse
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:creationTime:CreateConnectionResponse'
, createConnectionResponse_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:CreateConnectionResponse'
, createConnectionResponse_lastModifiedTime
- A time stamp for the time that the connection was last updated.
$sel:connectionArn:CreateConnectionResponse'
, createConnectionResponse_connectionArn
- The ARN of the connection that was created by the request.
$sel:connectionState:CreateConnectionResponse'
, createConnectionResponse_connectionState
- The state of the connection that was created by the request.
$sel:httpStatus:CreateConnectionResponse'
, createConnectionResponse_httpStatus
- The response's http status code.
Response Lenses
createConnectionResponse_creationTime :: Lens' CreateConnectionResponse (Maybe UTCTime) Source #
A time stamp for the time that the connection was created.
createConnectionResponse_lastModifiedTime :: Lens' CreateConnectionResponse (Maybe UTCTime) Source #
A time stamp for the time that the connection was last updated.
createConnectionResponse_connectionArn :: Lens' CreateConnectionResponse (Maybe Text) Source #
The ARN of the connection that was created by the request.
createConnectionResponse_connectionState :: Lens' CreateConnectionResponse (Maybe ConnectionState) Source #
The state of the connection that was created by the request.
createConnectionResponse_httpStatus :: Lens' CreateConnectionResponse Int Source #
The response's http status code.