Applications applicationId Policy

PDF

RSS

Focus mode

Applications applicationId Policy - AWS Serverless Application Repository

URI HTTP methods Schemas Properties See also

URI

/applications/applicationId/policy

HTTP methods

GET

Operation ID: GetApplicationPolicy

Retrieves the policy for the application.

Path parameters
Name	Type	Required	Description
`applicationId`	String	True	The Amazon Resource Name (ARN) of the application.

Responses
Status code	Response model	Description
`200`	`ApplicationPolicy`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`403`	`ForbiddenException`	The client is not authenticated.
`404`	`NotFoundException`	The resource (for example, an access policy statement) specified in the request doesn't exist.
`429`	`TooManyRequestsException`	The client is sending more than the allowed number of requests per unit of time.
`500`	`InternalServerErrorException`	The AWS Serverless Application Repository service encountered an internal error.

PUT

Operation ID: PutApplicationPolicy

Sets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions .

Path parameters
Name	Type	Required	Description
`applicationId`	String	True	The Amazon Resource Name (ARN) of the application.

Responses
Status code	Response model	Description
`200`	`ApplicationPolicy`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`403`	`ForbiddenException`	The client is not authenticated.
`404`	`NotFoundException`	The resource (for example, an access policy statement) specified in the request doesn't exist.
`429`	`TooManyRequestsException`	The client is sending more than the allowed number of requests per unit of time.
`500`	`InternalServerErrorException`	The AWS Serverless Application Repository service encountered an internal error.

OPTIONS

Path parameters
Name	Type	Required	Description
`applicationId`	String	True	The Amazon Resource Name (ARN) of the application.

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Request bodies


{
  "statements": [
    {
      "statementId": "string",
      "principals": [
        "string"
      ],
      "actions": [
        "string"
      ],
      "principalOrgIDs": [
        "string"
      ]
    }
  ]
}

PUT schema


{
  "statements": [
    {
      "statementId": "string",
      "principals": [
        "string"
      ],
      "actions": [
        "string"
      ],
      "principalOrgIDs": [
        "string"
      ]
    }
  ]
}

Response bodies


{
  "statements": [
    {
      "statementId": "string",
      "principals": [
        "string"
      ],
      "actions": [
        "string"
      ],
      "principalOrgIDs": [
        "string"
      ]
    }
  ]
}

ApplicationPolicy schema


{
  "statements": [
    {
      "statementId": "string",
      "principals": [
        "string"
      ],
      "actions": [
        "string"
      ],
      "principalOrgIDs": [
        "string"
      ]
    }
  ]
}


{
  "message": "string",
  "errorCode": "string"
}

BadRequestException schema


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}

ForbiddenException schema


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}

NotFoundException schema


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}

TooManyRequestsException schema


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}

InternalServerErrorException schema


{
  "message": "string",
  "errorCode": "string"
}

Properties

ApplicationPolicy

Policy statements applied to the application.

Property	Type	Required	Description
`statements`	Array of type ApplicationPolicyStatement	True	An array of policy statements applied to the application.

ApplicationPolicyStatement

Policy statement applied to the application.

Property	Type	Required	Description
`actions`	Array of type string	True	For the list of actions supported for this operation, see Application Permissions.
`principalOrgIDs`	Array of type string	False	The AWS Organizations ID to share the application with.
`principals`	Array of type string	True	An array of AWS account IDs to share the application with, or * to make the application public.
`statementId`	string	False	A unique ID for the statement.

BadRequestException

One of the parameters in the request is invalid.

Property	Type	Required	Description
`errorCode`	string	False	400
`message`	string	False	One of the parameters in the request is invalid.

ForbiddenException

The client is not authenticated.

Property	Type	Required	Description
`errorCode`	string	False	403
`message`	string	False	The client is not authenticated.

InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

Property	Type	Required	Description
`errorCode`	string	False	500
`message`	string	False	The AWS Serverless Application Repository service encountered an internal error.

NotFoundException

The resource (for example, an access policy statement) specified in the request doesn't exist.

Property	Type	Required	Description
`errorCode`	string	False	404
`message`	string	False	The resource (for example, an access policy statement) specified in the request doesn't exist.

TooManyRequestsException

The client is sending more than the allowed number of requests per unit of time.

Property	Type	Required	Description
`errorCode`	string	False	429
`message`	string	False	The client is sending more than the allowed number of requests per unit of time.

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Unable to save cookie preferences