UpdateSubscriber
Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
Request Syntax
PUT /v1/subscribers/id
HTTP/1.1
Content-type: application/json
{
"externalId": "string
",
"sourceTypes": [
{
"awsSourceType": "string
",
"customSourceType": "string
"
}
],
"subscriberDescription": "string
",
"subscriberName": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- id
-
A value created by Security Lake that uniquely identifies your subscription.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- externalId
-
The external ID of the Security Lake account.
Type: String
Pattern:
^[\\\w\-_:/.@=+]*$
Required: No
- sourceTypes
-
The supported AWS services from which logs and events are collected. For the list of supported AWS services, see the Amazon Security Lake User Guide.
Type: Array of SourceType objects
Required: No
- subscriberDescription
-
The description of the Security Lake account subscriber.
Type: String
Pattern:
^[\\\w\-_:/.@=+]*$
Required: No
- subscriberName
-
The name of the Security Lake account subscriber.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
^[\\\w\-_:/.@=+]*$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"subscriber": {
"accessTypes": [ "string" ],
"accountId": "string",
"createdAt": number,
"externalId": "string",
"roleArn": "string",
"s3BucketArn": "string",
"snsArn": "string",
"sourceTypes": [
{
"awsSourceType": "string",
"customSourceType": "string"
}
],
"subscriberDescription": "string",
"subscriberName": "string",
"subscriptionEndpoint": "string",
"subscriptionId": "string",
"subscriptionProtocol": "string",
"subscriptionStatus": "string",
"updatedAt": 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.
- subscriber
-
The account of the subscriber.
Type: SubscriberResource object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific AWS action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
HTTP Status Code: 403
- AccountNotFoundException
-
Amazon Security Lake cannot find an AWS account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
HTTP Status Code: 403
- ConcurrentModificationException
-
More than one process tried to modify a resource at the same time.
HTTP Status Code: 409
- ConflictSubscriptionException
-
A conflicting subscription exception operation is in progress.
HTTP Status Code: 400
- InternalServerException
-
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
HTTP Status Code: 500
- InvalidInputException
-
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.
HTTP Status Code: 400
- ValidationException
-
Your signing certificate could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: