Account Management Events Schema
Schema of events in the Account Management category
Article Tags
On This Page
AccountManagement: AccountUpdateEventAccountManagement: AccountCreateEventAccountManagement: AccountTypeCreateEventAccountManagement: AccountTypeUpdateEventAccountManagement: AccountTypeDeleteEventSee alsoEvents emitted from Stax Events follow a defined schema. For generic guidance, see Event Schemas.
AccountManagement: AccountUpdateEvent
An event where an AWS account has been modified.
{
"version": "0",
"id": "8d502d7e-57f3-afee-42e4-3e613f8e0b3a",
"detail-type": "AccountManagement: AccountUpdateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-02T01:20:57Z",
"region": "string",
"resources": [],
"detail": {
"accountId": "string",
"accountName": "string",
"accountType": "string",
"awsAccountId": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
}
},
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "AccountUpdateEvent",
"staxEventSource": "stax.account",
"staxEventTime": "string",
"staxEventType": "AccountManagement",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
» accountId | string | true | |
» awsAccountId | string | false | |
» accountName | string | false | |
» accountType | string | false | |
» status | string | true | - SUCCESS - FAILED |
» errorCode | string | false | |
» message | string | false |
AccountManagement: AccountCreateEvent
An event where an AWS account has been created via Stax.
{
"version": "0",
"id": "28dd95e7-2362-081a-222f-2e8edb5f466d",
"detail-type": "AccountManagement: AccountCreateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-02T01:50:27Z",
"region": "string",
"resources": [],
"detail": {
"accountId": "string",
"accountName": "string",
"accountType": "string",
"awsAccountId": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
}
},
"status": "SUCCESS",
"staxEventID": "string",
"staxEventName": "AccountCreateEvent",
"staxEventSource": "stax.account",
"staxEventTime": "string",
"staxEventType": "AccountManagement",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
» accountId | string | true | |
» awsAccountId | string | false | |
» accountName | string | false | |
» accountType | string | false | |
» status | string | true | - SUCCESS - FAILED |
» errorCode | string | false | |
» message | string | false |
AccountManagement: AccountTypeCreateEvent
An event where an account type has been created in Stax.
{
"version": "0",
"id": "aaddb2d4-df3b-4c46-1d02-355cfec8a767",
"detail-type": "AccountManagement: AccountTypeCreateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-02T01:54:23Z",
"region": "string",
"resources": [],
"detail": {
"accountTypeId": "string",
"accountTypeName": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"status": "SUCCESS",
"staxEventID": "03b2bb9d-3f58-4f07-b53f-86ccb995c848",
"staxEventName": "AccountTypeCreateEvent",
"staxEventSource": "stax.account",
"staxEventTime": "string",
"staxEventType": "AccountManagement",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
» accountTypeName | string | true | |
» accountTypeId | string | false | |
» status | string | true | - SUCCESS - FAILED |
» errorCode | string | false | - ReservedAccountType - AccountTypeConflict |
» message | string | false |
AccountManagement: AccountTypeUpdateEvent
An event where a Stax account type has been modified.
{
"version": "0",
"id": "2c6e7246-84a7-6b47-cbb8-067360e7a1b6",
"detail-type": "AccountManagement: AccountTypeUpdateEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-02T02:01:49Z",
"region": "string",
"resources": [],
"detail": {
"accountTypeId": "string",
"accountTypeName": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"status": "SUCCESS",
"staxEventID": "2fe4463f-faf0-4dbc-88c2-5269a4d65e82",
"staxEventName": "AccountTypeUpdateEvent",
"staxEventSource": "stax.account",
"staxEventTime": "string",
"staxEventType": "AccountManagement",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
» accountTypeId | string | true | |
» accountTypeName | string | true | |
» status | string | true | - SUCCESS - FAILED |
» errorCode | string | false | - ReservedAccountType - AccountTypeConflict - AccountTypeNotFound |
» message | string | false |
AccountManagement: AccountTypeDeleteEvent
An event where a Stax account type has been deleted.
{
"version": "0",
"id": "585a437c-7a0c-bf0d-719e-4f06f24d7f03",
"detail-type": "AccountManagement: AccountTypeDeleteEvent",
"source": "aws.partner/stax.io/123456789012/default",
"account": "123456789012",
"time": "2020-10-02T02:06:28Z",
"region": "string",
"resources": [],
"detail": {
"accountTypeId": "string",
"accountTypeName": "string",
"meta": {
"customer": {
"id": "string",
"name": "string"
},
"organization": {
"alias": "string",
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"username": "string"
}
},
"status": "SUCCESS",
"staxEventID": "92c3978a-f134-43c7-9c36-83074868ba40",
"staxEventName": "AccountTypeDeleteEvent",
"staxEventSource": "stax.account",
"staxEventTime": "string",
"staxEventType": "AccountManagement",
"staxEventVersion": "1"
}
}
This event contains the following unique properties in the detail object:
Property | Type | Required | Enum |
---|---|---|---|
» accountTypeId | string | true | |
» accountTypeName | string | true | |
» status | string | true | - SUCCESS - FAILED |
» errorCode | any | false | - ReservedAccountType - AccountTypeInUse |
» message | string | false |