Skip to content

Commit

Permalink
docs(client-managedblockchain): This is a minor documentation update …
Browse files Browse the repository at this point in the history 
…to address the impact of the shut down of the Goerli and Polygon networks.
  • Loading branch information
awstools committed May 24, 2024
1 parent 526c06c commit e4f5d35
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 26 deletions.
46 changes: 24 additions & 22 deletions clients/client-managedblockchain/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,18 +256,34 @@ export interface CreateAccessorInput {
/**
* <p>The blockchain network that the <code>Accessor</code> token is created for.</p>
* <note>
* <p>We recommend using the appropriate <code>networkType</code>
* value for the blockchain network that you are creating the <code>Accessor</code>
* token for. You cannnot use the value <code>ETHEREUM_MAINNET_AND_GOERLI</code> to
* specify a <code>networkType</code> for your Accessor token.</p>
* <p>The default value of <code>ETHEREUM_MAINNET_AND_GOERLI</code> is only applied:</p>
* <ul>
* <li>
* <p>when the <code>CreateAccessor</code> action does not set a <code>networkType</code>.</p>
* <p>Use the actual <code>networkType</code> value for the blockchain network that you are creating
* the <code>Accessor</code> token for.</p>
* </li>
* <li>
* <p>to all existing <code>Accessor</code> tokens that were created before the <code>networkType</code> property was introduced.
* </p>
* <p>With the shut down of the <i>Ethereum Goerli</i> and <i>Polygon Mumbai
* Testnet</i> networks the following <code>networkType</code> values are no longer available
* for selection and use.</p>
* <ul>
* <li>
* <p>
* <code>ETHEREUM_MAINNET_AND_GOERLI</code>
* </p>
* </li>
* <li>
* <p>
* <code>ETHEREUM_GOERLI</code>
* </p>
* </li>
* <li>
* <p>
* <code>POLYGON_MUMBAI</code>
* </p>
* </li>
* </ul>
* <p>However, your existing <code>Accessor</code> tokens with these <code>networkType</code>
* values will remain unchanged.</p>
* </li>
* </ul>
* </note>
Expand Down Expand Up @@ -920,11 +936,6 @@ export interface CreateNodeInput {
* <code>n-ethereum-mainnet</code>
* </p>
* </li>
* <li>
* <p>
* <code>n-ethereum-goerli</code>
* </p>
* </li>
* </ul>
* @public
*/
Expand Down Expand Up @@ -1126,11 +1137,6 @@ export interface DeleteNodeInput {
* <code>n-ethereum-mainnet</code>
* </p>
* </li>
* <li>
* <p>
* <code>n-ethereum-goerli</code>
* </p>
* </li>
* </ul>
* @public
*/
Expand Down Expand Up @@ -1385,10 +1391,6 @@ export interface NetworkEthereumAttributes {
* <p>mainnet = <code>1</code>
* </p>
* </li>
* <li>
* <p>goerli = <code>5</code>
* </p>
* </li>
* </ul>
* @public
*/
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/managedblockchain.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@
"NetworkType": {
"target": "com.amazonaws.managedblockchain#AccessorNetworkType",
"traits": {
"smithy.api#documentation": "<p>The blockchain network that the <code>Accessor</code> token is created for.</p>\n <note>\n <p>We recommend using the appropriate <code>networkType</code> \n value for the blockchain network that you are creating the <code>Accessor</code> \n token for. You cannnot use the value <code>ETHEREUM_MAINNET_AND_GOERLI</code> to \n specify a <code>networkType</code> for your Accessor token.</p>\n <p>The default value of <code>ETHEREUM_MAINNET_AND_GOERLI</code> is only applied:</p>\n <ul>\n <li>\n <p>when the <code>CreateAccessor</code> action does not set a <code>networkType</code>.</p>\n </li>\n <li>\n <p>to all existing <code>Accessor</code> tokens that were created before the <code>networkType</code> property was introduced.\n </p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>The blockchain network that the <code>Accessor</code> token is created for.</p>\n <note>\n <ul>\n <li>\n <p>Use the actual <code>networkType</code> value for the blockchain network that you are creating \n the <code>Accessor</code> token for.</p>\n </li>\n <li>\n <p>With the shut down of the <i>Ethereum Goerli</i> and <i>Polygon Mumbai \n Testnet</i> networks the following <code>networkType</code> values are no longer available \n for selection and use.</p>\n <ul>\n <li>\n <p>\n <code>ETHEREUM_MAINNET_AND_GOERLI</code>\n </p>\n </li>\n <li>\n <p>\n <code>ETHEREUM_GOERLI</code>\n </p>\n </li>\n <li>\n <p>\n <code>POLYGON_MUMBAI</code>\n </p>\n </li>\n </ul>\n <p>However, your existing <code>Accessor</code> tokens with these <code>networkType</code> \n values will remain unchanged.</p>\n </li>\n </ul>\n </note>"
}
}
},
Expand Down Expand Up @@ -671,7 +671,7 @@
"NetworkId": {
"target": "com.amazonaws.managedblockchain#ResourceIdString",
"traits": {
"smithy.api#documentation": "<p>The unique identifier of the network for the node.</p>\n <p>Ethereum public networks have the following <code>NetworkId</code>s:</p>\n <ul>\n <li>\n <p>\n <code>n-ethereum-mainnet</code>\n </p>\n </li>\n <li>\n <p>\n <code>n-ethereum-goerli</code>\n </p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>The unique identifier of the network for the node.</p>\n <p>Ethereum public networks have the following <code>NetworkId</code>s:</p>\n <ul>\n <li>\n <p>\n <code>n-ethereum-mainnet</code>\n </p>\n </li>\n </ul>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
Expand Down Expand Up @@ -986,7 +986,7 @@
"NetworkId": {
"target": "com.amazonaws.managedblockchain#ResourceIdString",
"traits": {
"smithy.api#documentation": "<p>The unique identifier of the network that the node is on.</p>\n <p>Ethereum public networks have the following <code>NetworkId</code>s:</p>\n <ul>\n <li>\n <p>\n <code>n-ethereum-mainnet</code>\n </p>\n </li>\n <li>\n <p>\n <code>n-ethereum-goerli</code>\n </p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>The unique identifier of the network that the node is on.</p>\n <p>Ethereum public networks have the following <code>NetworkId</code>s:</p>\n <ul>\n <li>\n <p>\n <code>n-ethereum-mainnet</code>\n </p>\n </li>\n </ul>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
Expand Down Expand Up @@ -2760,7 +2760,7 @@
"ChainId": {
"target": "com.amazonaws.managedblockchain#String",
"traits": {
"smithy.api#documentation": "<p>The Ethereum <code>CHAIN_ID</code> associated with the Ethereum network. Chain IDs are as follows:</p>\n <ul>\n <li>\n <p>mainnet = <code>1</code>\n </p>\n </li>\n <li>\n <p>goerli = <code>5</code>\n </p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>The Ethereum <code>CHAIN_ID</code> associated with the Ethereum network. Chain IDs are as follows:</p>\n <ul>\n <li>\n <p>mainnet = <code>1</code>\n </p>\n </li>\n </ul>"
}
}
},
Expand Down

0 comments on commit e4f5d35

Please sign in to comment.