CreateFleetAdvisorCollector
Creates a Fleet Advisor collector using the specified parameters.
Request Syntax
{
"CollectorName": "string",
"Description": "string",
"S3BucketName": "string",
"ServiceAccessRoleArn": "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.
- CollectorName
-
The name of your Fleet Advisor collector (for example,
sample-collector).Type: String
Required: Yes
- Description
-
A summary description of your Fleet Advisor collector.
Type: String
Required: No
- S3BucketName
-
The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
Type: String
Required: Yes
- ServiceAccessRoleArn
-
The IAM role that grants permissions to access the specified Amazon S3 bucket.
Type: String
Required: Yes
Response Syntax
{
"CollectorName": "string",
"CollectorReferencedId": "string",
"Description": "string",
"S3BucketName": "string",
"ServiceAccessRoleArn": "string"
}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.
- CollectorName
-
The name of the new Fleet Advisor collector.
Type: String
- CollectorReferencedId
-
The unique ID of the new Fleet Advisor collector, for example:
22fda70c-40d5-4acf-b233-a495bd8eb7f5Type: String
- Description
-
A summary description of the Fleet Advisor collector.
Type: String
- S3BucketName
-
The Amazon S3 bucket that the collector uses to store inventory metadata.
Type: String
- ServiceAccessRoleArn
-
The IAM role that grants permissions to access the specified Amazon S3 bucket.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
Amazon DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- ResourceQuotaExceededFault
-
The quota for this resource quota has been exceeded.
HTTP Status Code: 400
- S3AccessDeniedFault
-
Insufficient privileges are preventing access to an Amazon S3 object.
HTTP Status Code: 400
- S3ResourceNotFoundFault
-
A specified Amazon S3 bucket, bucket folder, or other object can't be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: