UpdateConnection
Updates settings for a connection.
Request Syntax
{
"AuthorizationType": "string",
"AuthParameters": {
"ApiKeyAuthParameters": {
"ApiKeyName": "string",
"ApiKeyValue": "string"
},
"BasicAuthParameters": {
"Password": "string",
"Username": "string"
},
"ConnectivityParameters": {
"ResourceParameters": {
"ResourceConfigurationArn": "string"
}
},
"InvocationHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
},
"OAuthParameters": {
"AuthorizationEndpoint": "string",
"ClientParameters": {
"ClientID": "string",
"ClientSecret": "string"
},
"HttpMethod": "string",
"OAuthHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
}
}
},
"Description": "string",
"InvocationConnectivityParameters": {
"ResourceParameters": {
"ResourceConfigurationArn": "string"
}
},
"Name": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AuthorizationType
-
The type of authorization to use for the connection.
Type: String
Valid Values:
BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEYRequired: No
- AuthParameters
-
The authorization parameters to use for the connection.
Type: UpdateConnectionAuthRequestParameters object
Required: No
- Description
-
A description for the connection.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.*Required: No
- InvocationConnectivityParameters
-
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
Type: ConnectivityResourceParameters object
Required: No
- Name
-
The name of the connection to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: Yes
Response Syntax
{
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastAuthorizedTime": number,
"LastModifiedTime": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ConnectionArn
-
The ARN of the connection that was updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$ - ConnectionState
-
The state of the connection that was updated.
Type: String
Valid Values:
CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY - CreationTime
-
A time stamp for the time that the connection was created.
Type: Timestamp
- LastAuthorizedTime
-
A time stamp for the time that the connection was last authorized.
Type: Timestamp
- LastModifiedTime
-
A time stamp for the time that the connection was last modified.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have the necessary permissions for this action.
HTTP Status Code: 400
- ConcurrentModificationException
-
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- LimitExceededException
-
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
- ThrottlingException
-
This request cannot be completed due to throttling issues.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
