# CreateScope
<a name="API_CreateScope"></a>

Creates a scope. A scope selects the accounts and resources that a deployment applies to. Use `isPublished` to create the scope in published (`ACTIVE`) or draft (`DRAFT`) state.

## Request Syntax
<a name="API_CreateScope_RequestSyntax"></a>

```
POST /scopes HTTP/1.1
Content-type: application/json

{
   "clientToken": "{{string}}",
   "isPublished": {{boolean}},
   "scopeConfiguration": { 
      "accountFilter": { ... },
      "resourceScopes": { 
         "{{string}}" : { 
            "exclude": { 
               "explicitArns": [ "{{string}}" ],
               "expression": { ... }
            },
            "include": { 
               "explicitArns": [ "{{string}}" ],
               "expression": { ... }
            },
            "includeAll": {{boolean}}
         }
      }
   },
   "scopeDescription": "{{string}}",
   "scopeName": "{{string}}",
   "tags": { 
      "{{string}}" : "{{string}}" 
   }
}
```

## URI Request Parameters
<a name="API_CreateScope_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateScope_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateScope_RequestSyntax) **   <a name="networksecuritymanager-CreateScope-request-clientToken"></a>
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [isPublished](#API_CreateScope_RequestSyntax) **   <a name="networksecuritymanager-CreateScope-request-isPublished"></a>
Specifies whether to publish the resource. When `true`, the resource is saved in published (`ACTIVE`) state. When `false`, it is saved as a draft (`DRAFT`). Default: `true`.  
Type: Boolean  
Required: No

 ** [scopeConfiguration](#API_CreateScope_RequestSyntax) **   <a name="networksecuritymanager-CreateScope-request-scopeConfiguration"></a>
The configuration that defines which accounts and resources are in scope.  
Type: [ScopeConfiguration](API_ScopeConfiguration.md) object  
Required: Yes

 ** [scopeDescription](#API_CreateScope_RequestSyntax) **   <a name="networksecuritymanager-CreateScope-request-scopeDescription"></a>
A description of the scope.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.:/=+\-@]*`   
Required: No

 ** [scopeName](#API_CreateScope_RequestSyntax) **   <a name="networksecuritymanager-CreateScope-request-scopeName"></a>
The name of the scope.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\-@]*`   
Required: Yes

 ** [tags](#API_CreateScope_RequestSyntax) **   <a name="networksecuritymanager-CreateScope-request-tags"></a>
The tags to add to the resource when it is created.  
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.  
Key Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateScope_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "hasPublishedVersion": boolean,
   "isSnapshot": boolean,
   "scopeArn": "string",
   "scopeConfiguration": { 
      "accountFilter": { ... },
      "resourceScopes": { 
         "string" : { 
            "exclude": { 
               "explicitArns": [ "string" ],
               "expression": { ... }
            },
            "include": { 
               "explicitArns": [ "string" ],
               "expression": { ... }
            },
            "includeAll": boolean
         }
      }
   },
   "scopeDescription": "string",
   "scopeId": "string",
   "scopeName": "string",
   "status": "string",
   "updatedAt": "string",
   "updateToken": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateScope_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [hasPublishedVersion](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-hasPublishedVersion"></a>
Specifies whether a published version of the resource exists.  
Type: Boolean

 ** [isSnapshot](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-isSnapshot"></a>
Specifies whether the resource is a snapshot of a published version.  
Type: Boolean

 ** [scopeArn](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-scopeArn"></a>
The Amazon Resource Name (ARN) of the scope.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1010.  
Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)` 

 ** [scopeConfiguration](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-scopeConfiguration"></a>
The configuration that defines which accounts and resources are in scope.  
Type: [ScopeConfiguration](API_ScopeConfiguration.md) object

 ** [scopeDescription](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-scopeDescription"></a>
A description of the scope.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[a-zA-Z0-9 _.:/=+\-@]*` 

 ** [scopeId](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-scopeId"></a>
The service-generated id of the scope.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-z0-9]{1,64}` 

 ** [scopeName](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-scopeName"></a>
The name of the scope.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\-@]*` 

 ** [status](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-status"></a>
The current status of the resource: `DRAFT` (unpublished, editable) or `ACTIVE` (published, in use).  
Type: String  
Valid Values: `DRAFT | ACTIVE | DISABLED` 

 ** [updatedAt](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-updatedAt"></a>
The time when the resource was last updated.  
Type: Timestamp

 ** [updateToken](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-updateToken"></a>
A token used for optimistic concurrency control. Each read and write returns an `updateToken`. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})` 

 ** [version](#API_CreateScope_ResponseSyntax) **   <a name="networksecuritymanager-CreateScope-response-version"></a>
The version of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `[1-9][0-9]*` 

## Errors
<a name="API_CreateScope_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request conflicts with the current state of the resource. For example, the resource was modified concurrently, or it is in a state that does not allow the requested operation.    
 ** resourceId **   
The ID of the resource that is in conflict with the request.  
 ** resourceType **   
The type of the resource that is in conflict with the request.
HTTP Status Code: 409

 ** InternalServerException **   
The request processing failed because of an internal error in the service. This is a retryable error.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request would exceed a service quota.    
 ** quotaCode **   
The code that identifies the service quota that was exceeded.  
 ** resourceId **   
The ID of the resource associated with the quota that was exceeded.  
 ** resourceType **   
The type of the resource associated with the quota that was exceeded.  
 ** serviceCode **   
The code for the AWS service that owns the quota that was exceeded.
HTTP Status Code: 402

 ** ServiceUnavailableException **   
The service is temporarily unavailable. This is a retryable error.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request.
HTTP Status Code: 503

 ** TagPolicyViolationException **   
The request violates a tag policy that is in effect for the account or organization.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied because of request throttling. Reduce your request rate and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request.
HTTP Status Code: 429

 ** ValidationException **   
The request failed validation. For details, see the `reason` and `fieldList` members of the response.    
 ** fieldList **   
The list of request fields that failed validation, if any.  
 ** reason **   
The reason that the request failed validation.
HTTP Status Code: 400

## See Also
<a name="API_CreateScope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for Python (Boto3)](https://docs.aws.amazon.com/goto/boto3/network-security-manager-2025-10-30/CreateScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-security-manager-2025-10-30/CreateScope)