GetScope
Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.
Request Syntax
GET /scopes/scopeId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- scopeId
-
The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a
CreateScopeAPI call.Length Constraints: Minimum length of 1.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"scopeArn": "string",
"scopeId": "string",
"status": "string",
"tags": {
"string" : "string"
},
"targets": [
{
"region": "string",
"targetIdentifier": {
"targetId": { ... },
"targetType": "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.
- scopeArn
-
The Amazon Resource Name (ARN) of the scope.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.* - scopeId
-
The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a
CreateScopeAPI call.Type: String
- status
-
The status of a scope. The status can be one of the following:
SUCCEEDED,IN_PROGRESS, orFAILED.Type: String
Valid Values:
SUCCEEDED | IN_PROGRESS | FAILED -
The tags for a scope.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- targets
-
The targets for a scope
Type: Array of TargetResource objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permission to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request specifies a resource that doesn't exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request exceeded a service quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
Invalid request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
